FormatConditionRangeGradient Class

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

Declaration

export class FormatConditionRangeGradient extends FormatConditionRangeBase

constructor

Initializes a new instance of the FormatConditionRangeGradient class.

Declaration

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

Optional Parameters

Name Type Default Description
modelJson any null

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

serializer ModelSerializer null

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

Properties

getSpecificType Property

Declaration

getSpecificType: () => FormatConditionRangeGradientPredefinedType

Property Value

Type Description
() => FormatConditionRangeGradientPredefinedType

segmentNumber Property

Declaration

segmentNumber: ko.Computed<number>

Property Value

Type Description
ko.Computed<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

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

generateAsPercent(startStyle, endStyle, segmentNumber) Method

Declaration

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

Parameters

Name Type Description
startStyle StyleSettingsBase
endStyle StyleSettingsBase
segmentNumber number

getActualPredefinedType Method

Declaration

getActualPredefinedType(): FormatConditionRangeGradientPredefinedType

Returns

Type Description
FormatConditionRangeGradientPredefinedType

getInfo Method

For internal use.

Declaration

getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

Returns

Type Description
ISerializationInfoArray

An array of objects that provide serialization info.

isGradient Method

Declaration

isGradient(): boolean

Returns

Type Description
boolean

setActualPredefinedType(type) Method

Declaration

setActualPredefinedType(type: FormatConditionRangeGradientPredefinedType): void

Parameters

Name Type Description
type FormatConditionRangeGradientPredefinedType