Skip to main content

ColorSchemeEntry Class

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

#Declaration

TypeScript
export class ColorSchemeEntry extends TypedSerializableModel implements IDashboardComponent

#Implements

IDashboardComponent

#Inherited Members

#constructor

Initializes a new instance of the ColorSchemeEntry class.

#Declaration

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

#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.

itemComponentName string
name string

#Properties

#color Property

#Declaration

TypeScript
color: ko.Observable<DevExpress.Dashboard.Model.Color>

#Property Value

Type
Observable<Color>

#colorText Property

#Declaration

TypeScript
colorText: ko.Computed<string>

#Property Value

Type
Computed<string>

#componentName Property

#Declaration

TypeScript
componentName: ko.Subscribable<string>

#Property Value

Type
Subscribable<string>

#custom Property

#Declaration

TypeScript
get custom(): boolean

#Property Value

Type
boolean

#dataMember Property

#Declaration

TypeScript
dataMember: ko.Observable<string>

#Property Value

Type
Observable<string>

#dataSource Property

#Declaration

TypeScript
dataSource: ko.Observable<string>

#Property Value

Type
Observable<string>

#definition Property

#Declaration

TypeScript
get definition(): DevExpress.Dashboard.Model.ColorSchemeDefinition

#Property Value

Type
ColorSchemeDefinition

#dimensionKeys Property

#Declaration

TypeScript
dimensionKeys: ko.ObservableArray<DevExpress.Dashboard.Model.DimensionKey>

#Property Value

Type
ObservableArray<DimensionKey>

#displayText Property

#Declaration

TypeScript
displayText: ko.Subscribable<string>

#Property Value

Type
Subscribable<string>

#itemComponentName Property

#Declaration

TypeScript
itemComponentName: string

#Property Value

Type
string

#measureKeys Property

#Declaration

TypeScript
measureKeys: ko.ObservableArray<DevExpress.Dashboard.Model.MeasureDefinition>

#Property Value

Type
ObservableArray<MeasureDefinition>

#paletteIndex Property

#Declaration

TypeScript
paletteIndex: ko.Observable<number>

#Property Value

Type
Observable<number>

#Methods

#clone Method

#Declaration

TypeScript

#Returns

Type
ColorSchemeEntry

#dispose Method

Disposes of all resources associated with this ColorSchemeEntry.

#Declaration

TypeScript
dispose(): void

#equals(entry) Method

#Declaration

TypeScript
equals(
    entry: ColorSchemeEntry
): boolean

#Parameters

Name Type
entry ColorSchemeEntry

#Returns

Type
boolean

#getInfo Method

For internal use.

#Declaration

TypeScript
getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

#Returns

Type Description
ISerializationInfoArray

An array of objects that provide serialization info.

#getUniqueNamePrefix Method

#Declaration

TypeScript
getUniqueNamePrefix(): string

#Returns

Type
string