ColorSchemeEntry Class

A color scheme entry used to map the dimension values/measures and the specified color.

Declaration

export class ColorSchemeEntry extends TypedSerializableModel implements IDashboardComponent

constructor

Initializes a new instance of the ColorSchemeEntry class.

Declaration

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

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.

itemComponentName string null
name string null

Properties

color Property

Declaration

color: ko.Observable<Color>

Property Value

Type Description
ko.Observable<Color>

colorText Property

Declaration

colorText: ko.Computed<string>

Property Value

Type Description
ko.Computed<string>

componentName Property

Declaration

componentName: ko.Subscribable<string>

Property Value

Type Description
ko.Subscribable<string>

custom Property

Declaration

readonly custom: boolean

Property Value

Type Description
boolean

dataMember Property

Declaration

dataMember: ko.Observable<string>

Property Value

Type Description
ko.Observable<string>

dataSource Property

Declaration

dataSource: ko.Observable<string>

Property Value

Type Description
ko.Observable<string>

definition Property

Declaration

readonly definition: ColorSchemeDefinition

Property Value

Type Description
ColorSchemeDefinition

dimensionKeys Property

Declaration

dimensionKeys: ko.ObservableArray<DimensionKey>

Property Value

Type Description
ko.ObservableArray<DimensionKey>

displayText Property

Declaration

displayText: ko.Subscribable<string>

Property Value

Type Description
ko.Subscribable<string>

itemComponentName Property

Declaration

itemComponentName: string

Property Value

Type Description
string

measureKeys Property

Declaration

measureKeys: ko.ObservableArray<MeasureDefinition>

Property Value

Type Description
ko.ObservableArray<MeasureDefinition>

paletteIndex Property

Declaration

paletteIndex: ko.Observable<number>

Property Value

Type Description
ko.Observable<number>

Methods

clone Method

Declaration

clone(): ColorSchemeEntry

Returns

Type Description
ColorSchemeEntry

equals(entry) Method

Declaration

equals(entry: ColorSchemeEntry): boolean

Parameters

Name Type Description
entry ColorSchemeEntry

Returns

Type Description
boolean

getInfo Method

For internal use.

Declaration

getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

Returns

Type Description
ISerializationInfoArray

An array of objects that provide serialization info.

getUniqueNamePrefix Method

Declaration

getUniqueNamePrefix(): string

Returns

Type Description
string