FormatConditionRangeGradient Class

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

Declaration

export class FormatConditionRangeGradient extends FormatConditionRangeBase

Inherited Members

dataType

dateTimeGroupInterval

disposed

isEmpty

rangeSet

valueType

actualStyles

stopStyles

createStyleSettings(styleListItem)

init

isRange

isValid

setValues(values)

Inheritance

SerializableModel

FormatConditionBase

FormatConditionRangeBase

FormatConditionRangeGradient

FormatConditionGradientRangeBar

constructor

Initializes a new instance of the FormatConditionRangeGradient class.

Declaration

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

Parameters

Name	Type	Description
modelJson	any	A JSON object used for dashboard deserialization. Do not pass this parameter directly.
serializer	ModelSerializer	An object used for dashboard deserialization. Do not pass this parameter directly.

Properties

getSpecificType Property

Declaration

getSpecificType: () => DevExpress.Dashboard.Model.FormatConditionRangeGradientPredefinedType

Property Value

Type
() => FormatConditionRangeGradientPredefinedType

segmentNumber Property

Declaration

segmentNumber: ko.Computed<number>

Property Value

Type
Computed<number>

setSpecificType Property

Declaration

setSpecificType: (specificType: any) => void

Property Value

Type
(specificType: any) => void

Methods

generateAsNumber(startStyle, endStyle, values) Method

Declaration

generateAsNumber(
    startStyle: DevExpress.Dashboard.Model.StyleSettingsBase,
    endStyle: DevExpress.Dashboard.Model.StyleSettingsBase,
    values: Array<any>
): void

Parameters

Name	Type
startStyle	StyleSettingsBase
endStyle	StyleSettingsBase
values	any[]

generateAsPercent(startStyle, endStyle, segmentNumber) Method

Declaration

generateAsPercent(
    startStyle: DevExpress.Dashboard.Model.StyleSettingsBase,
    endStyle: DevExpress.Dashboard.Model.StyleSettingsBase,
    segmentNumber: number
): void

Parameters

Name	Type
startStyle	StyleSettingsBase
endStyle	StyleSettingsBase
segmentNumber	number

getActualPredefinedType Method

Declaration

getActualPredefinedType(): DevExpress.Dashboard.Model.FormatConditionRangeGradientPredefinedType

Returns

Type
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
boolean

setActualPredefinedType(type) Method

Declaration

setActualPredefinedType(
    type: DevExpress.Dashboard.Model.FormatConditionRangeGradientPredefinedType
): void

Parameters

Name	Type
type	FormatConditionRangeGradientPredefinedType