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

Implements

IDashboardComponent

Inherited Members

disposed

itemType

Inheritance

SerializableModel

TypedSerializableModel

ColorSchemeEntry

AutoColorSchemeEntry

constructor

Initializes a new instance of the ColorSchemeEntry class.

Declaration

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

color: ko.Observable<DevExpress.Dashboard.Model.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>

custom Property

Declaration

get 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

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

Property Value

Type
ColorSchemeDefinition

dimensionKeys Property

Declaration

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

Property Value

Type
ObservableArray<DimensionKey>

displayText Property

Declaration

displayText: ko.Subscribable<string>

Property Value

Type
Subscribable<string>

hatchStyle Property

Specifies the entry’s hatch style.

Declaration

hatchStyle: ko.Observable<DevExpress.Dashboard.Model.HatchStyle>

Property Value

Type	Description
Observable<HatchStyle>	An observable that specifies the entry’s hatch style.

itemComponentName Property

Declaration

itemComponentName: string

Property Value

Type
string

lineStyle Property

Specifies the entry’s line style.

Declaration

lineStyle: ko.Observable<DevExpress.Dashboard.Model.DashStyle>

Property Value

Type	Description
Observable<DashStyle>	An observable that specifies the entry’s line style.

measureKeys Property

Declaration

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

Property Value

Type
ObservableArray<MeasureDefinition>

paletteIndex Property

Gets a zero-based index that identifies a color from a predefined palette.

Declaration

paletteIndex: ko.Observable<number>

Property Value

Type	Description
Observable<number>	An integer value that specifies the zero-based index of a color in a predefined palette.

Methods

clone Method

Declaration

clone(): ColorSchemeEntry

Returns

Type
ColorSchemeEntry

dispose Method

Disposes of all resources associated with this ColorSchemeEntry.

Declaration

dispose(): void

equals(entry) Method

Declaration

equals(
    entry: ColorSchemeEntry
): boolean

Parameters

Name	Type
entry	ColorSchemeEntry

Returns

Type
boolean

getColorSchemeEntryElements(palette) Method

Returns the color, hatch style, and line style for the entry.

Declaration

getColorSchemeEntryElements(palette: DashboardPaletteItem[]): {
    color: DevExpress.Dashboard.Model.Color;
    hatchStyle: DevExpress.Dashboard.Model.HatchStyle;
    lineStyle: DevExpress.Dashboard.Model.DashStyle;
}

Parameters

Name	Type	Description
palette	DashboardPaletteItem[]	The palette used to resolve the entry’s appearance.

Returns

Type	Description
{color: Color, hatchStyle: HatchStyle, lineStyle: DashStyle}	An object that contains the color, hatch style, and line style.

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
string