All docs
V18.2
19.1 (preview)
18.2
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

FormatConditionRangeGradient Class

A format condition used to apply formatting using value ranges and a specified color gradient.

Declaration

export class FormatConditionRangeGradient extends FormatConditionRangeBase

Inheritance

constructor

Initializes a new instance of the FormatConditionRangeGradient class.

Declaration

constructor(modelJson?: any, serializer?: DxDesigner.Analytics.Utils.ModelSerializer)

Parameters

Type Name Description
any modelJson

A JSON object used for a dashboard deserialization. Do not pass this parameter directly.

DxDesigner.Analytics.Utils.ModelSerializer serializer

An object used for a dashboard deserialization. Do not pass this parameter directly.

Properties

getSpecificType Property

Declaration

getSpecificType: () => FormatConditionRangeGradientPredefinedType

Property Value

Type Description
() => FormatConditionRangeGradientPredefinedType

segmentNumber Property

Declaration

segmentNumber: KnockoutComputed<number>

Property Value

Type Description
KnockoutComputed<number>

setSpecificType Property

Declaration

setSpecificType: (specificType: any) => void

Property Value

Type Description
(specificType: any) => void

Methods

generateAsNumber(startStyle, endStyle, values) Method

Declaration

generateAsNumber(startStyle: StyleSettingsBase, endStyle: StyleSettingsBase, values: Array<any>): void

Parameters

Type Name Description
StyleSettingsBase startStyle
StyleSettingsBase endStyle
Array<any> values

generateAsPercent(startStyle, endStyle, segmentNumber) Method

Declaration

generateAsPercent(startStyle: StyleSettingsBase, endStyle: StyleSettingsBase, segmentNumber: number): void

Parameters

Type Name Description
StyleSettingsBase startStyle
StyleSettingsBase endStyle
number segmentNumber

getActualPredefinedType Method

Declaration

getActualPredefinedType(): FormatConditionRangeGradientPredefinedType

Returns

Type Description
FormatConditionRangeGradientPredefinedType

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationsInfo

Returns

Type Description
DxDesigner.Analytics.Utils.ISerializationsInfo

 

isGradient Method

Declaration

isGradient(): boolean

Returns

Type Description
boolean

setActualPredefinedType(type) Method

Declaration

setActualPredefinedType(type: FormatConditionRangeGradientPredefinedType): void

Parameters

Type Name Description
FormatConditionRangeGradientPredefinedType type