FormatConditionRangeGradient Class
A format condition used to apply formatting using value ranges and a specified color gradient.
#Declaration
TypeScript
export class FormatConditionRangeGradient extends FormatConditionRangeBase
#Inherited Members
#Inheritance
SerializableModel
FormatConditionBase
FormatConditionRangeBase
FormatConditionRangeGradient
#constructor
Initializes a new instance of the FormatConditionRangeGradient
class.
#Declaration
TypeScript
constructor(
modelJson?: any,
serializer?: DevExpress.Analytics.Utils.ModelSerializer
)
#Parameters
Name | Type | Description |
---|---|---|
model |
any | A JSON object used for dashboard deserialization. Do not pass this parameter directly. |
serializer | Model |
An object used for dashboard deserialization. Do not pass this parameter directly. |
#Properties
#getSpecificType Property
#Declaration
TypeScript
getSpecificType: () => DevExpress.Dashboard.Model.FormatConditionRangeGradientPredefinedType
#Property Value
Type |
---|
() => Format |
#segmentNumber Property
#Declaration
TypeScript
segmentNumber: ko.Computed<number>
#Property Value
Type |
---|
Computed<number> |
#setSpecificType Property
#Declaration
TypeScript
setSpecificType: (specificType: any) => void
#Property Value
Type |
---|
(specific |
#Methods
#generateAsNumber(startStyle, endStyle, values) Method
#Declaration
TypeScript
generateAsNumber(
startStyle: DevExpress.Dashboard.Model.StyleSettingsBase,
endStyle: DevExpress.Dashboard.Model.StyleSettingsBase,
values: Array<any>
): void
#Parameters
Name | Type |
---|---|
start |
Style |
end |
Style |
values | any[] |
#generateAsPercent(startStyle, endStyle, segmentNumber) Method
#Declaration
TypeScript
generateAsPercent(
startStyle: DevExpress.Dashboard.Model.StyleSettingsBase,
endStyle: DevExpress.Dashboard.Model.StyleSettingsBase,
segmentNumber: number
): void
#Parameters
Name | Type |
---|---|
start |
Style |
end |
Style |
segment |
number |
#getActualPredefinedType Method
#Declaration
TypeScript
getActualPredefinedType(): DevExpress.Dashboard.Model.FormatConditionRangeGradientPredefinedType
#Returns
Type |
---|
Format |
#getInfo Method
For internal use.
#Declaration
TypeScript
getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray
#Returns
Type | Description |
---|---|
ISerialization |
An array of objects that provide serialization info. |
#isGradient Method
#Declaration
TypeScript
isGradient(): boolean
#Returns
Type |
---|
boolean |
#setActualPredefinedType(type) Method
#Declaration
TypeScript
setActualPredefinedType(
type: DevExpress.Dashboard.Model.FormatConditionRangeGradientPredefinedType
): void
#Parameters
Name | Type |
---|---|
type | Format |