DashboardItemColoringOptions Class

Contains dashboard item coloring options.

Declaration

export class DashboardItemColoringOptions extends SerializableModel

Remarks

Dashboard items that support coloring expose the DataDashboardItem.coloringOptions property that allows you to access coloring options. Use this property to get access to DashboardItemColoringOptions:

useGlobalColors

Specifies whether the dashboard item uses a global or local color scheme.

measuresColoringMode

Specifies a coloring mode for dashboard item measures.

Inherited Members

disposed

Inheritance

SerializableModel

DashboardItemColoringOptions

constructor

Initializes a new instance of the DashboardItemColoringOptions class.

Declaration

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

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.

Properties

measuresColoringMode Property

Specifies a coloring mode for dashboard item measures.

Declaration

measuresColoringMode: ko.Observable<DevExpress.Dashboard.Model.ColoringMode>

Property Value

Type	Description
Observable<ColoringMode>	A ColoringMode value that specifies a coloring mode for dashboard item measures.

useGlobalColors Property

Specifies whether the dashboard item uses a global or local color scheme.

Declaration

useGlobalColors: ko.Observable<boolean>

Property Value

Type	Description
Observable<boolean>	true if the dashboard item uses a global color scheme; otherwise, the dashboard item uses a local color scheme.

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

Returns

Type	Description
ISerializationInfoArray	An array of objects that provide serialization info.