The requested page is not available for the requested platform. You are viewing the content for Default platform.

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?: DxDesigner.Analytics.Utils.ModelSerializer)

Optional Parameters

Name Type Default Description
modelJson any null

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

serializer DxDesigner.Analytics.Utils.ModelSerializer null

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: 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(): DxDesigner.Analytics.Utils.ISerializationInfoArray

Returns

Type Description
DxDesigner.Analytics.Utils.ISerializationInfoArray

 

isGradient Method

Declaration

isGradient(): boolean

Returns

Type Description
boolean

setActualPredefinedType(type) Method

Declaration

setActualPredefinedType(type: FormatConditionRangeGradientPredefinedType): void

Parameters

Name Type Description
type FormatConditionRangeGradientPredefinedType