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

Inherited Members

itemType

Inheritance

ColorSchemeEntry

AutoColorSchemeEntry

constructor

Initializes a new instance of the ColorSchemeEntry class.

Declaration

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

Parameters

Name	Type	Description
modelJson	any	A JSON object used for a dashboard deserialization. Do not pass this parameter directly.
serializer	DxDesigner.Analytics.Utils.ModelSerializer	An object used for a dashboard deserialization. Do not pass this parameter directly.
itemComponentName	string
name	string

Properties

color Property

Declaration

color: ko.Observable<Color>

Property Value

Type
Observable<Color>

colorText Property

Declaration

colorText: ko.Computed<string>

Property Value

Type
Computed<string>

componentName Property

Declaration

componentName: ko.Subscribable<string>

Property Value

Type
Subscribable<string>

computedColor Property

Declaration

computedColor: ko.Computed<Color>

Property Value

Type
Computed<Color>

custom Property

Declaration

readonly custom: boolean

Property Value

Type
boolean

dataMember Property

Declaration

dataMember: ko.Observable<string>

Property Value

Type
Observable<string>

dataSource Property

Declaration

dataSource: ko.Observable<string>

Property Value

Type
Observable<string>

definition Property

Declaration

readonly definition: ColorSchemeDefinition

Property Value

Type
ColorSchemeDefinition

dimensionKeys Property

Declaration

dimensionKeys: ko.ObservableArray<DimensionKey>

Property Value

Type
ObservableArray<DimensionKey>

displayText Property

Declaration

displayText: ko.Subscribable<string>

Property Value

Type
Subscribable<string>

itemComponentName Property

Declaration

itemComponentName: string

Property Value

Type
string

measureKeys Property

Declaration

measureKeys: ko.ObservableArray<MeasureDefinition>

Property Value

Type
ObservableArray<MeasureDefinition>

paletteIndex Property

Declaration

paletteIndex: ko.Observable<number>

Property Value

Type
Observable<number>

Methods

clone Method

Declaration

clone(): ColorSchemeEntry

Returns

Type
ColorSchemeEntry

equals(entry) Method

Declaration

equals(
    entry: ColorSchemeEntry
): boolean

Parameters

Name	Type
entry	ColorSchemeEntry

Returns

Type
boolean

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationInfoArray

Returns

Type	Description
DxDesigner.Analytics.Utils.ISerializationInfoArray

getUniqueNamePrefix Method

Declaration

getUniqueNamePrefix(): string

Returns

Type
string