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: KnockoutObservable<Color>

Property Value

Type
KnockoutObservable<Color>

colorText Property

Declaration

colorText: KnockoutComputed<string>

Property Value

Type
KnockoutComputed<string>

componentName Property

Declaration

componentName: KnockoutObservable<string>

Property Value

Type
KnockoutObservable<string>

computedColor Property

Declaration

computedColor: KnockoutComputed<Color>

Property Value

Type
KnockoutComputed<Color>

custom Property

Declaration

readonly custom: boolean

Property Value

Type
boolean

dataMember Property

Declaration

dataMember: KnockoutObservable<string>

Property Value

Type
KnockoutObservable<string>

dataSource Property

Declaration

dataSource: KnockoutObservable<string>

Property Value

Type
KnockoutObservable<string>

definition Property

Declaration

readonly definition: ColorSchemeDefinition

Property Value

Type
ColorSchemeDefinition

dimensionKeys Property

Declaration

dimensionKeys: KnockoutObservableArray<DimensionKey>

Property Value

Type
KnockoutObservableArray<DimensionKey>

displayText Property

Declaration

displayText: KnockoutObservable<string>

Property Value

Type
KnockoutObservable<string>

itemComponentName Property

Declaration

itemComponentName: string

Property Value

Type
string

measureKeys Property

Declaration

measureKeys: KnockoutObservableArray<MeasureDefinition>

Property Value

Type
KnockoutObservableArray<MeasureDefinition>

paletteIndex Property

Declaration

paletteIndex: KnockoutObservable<number>

Property Value

Type
KnockoutObservable<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.ISerializationsInfo

Returns

Type	Description
DxDesigner.Analytics.Utils.ISerializationsInfo

getUniqueNamePrefix Method

Declaration

getUniqueNamePrefix(): string

Returns

Type
string