DashboardItemFormatRule Class

A format rule used to apply conditional formatting to dashboard items.

Declaration

export abstract class DashboardItemFormatRule extends TypedSerializableModel

Inheritance

constructor

Initializes a new instance of the DashboardItemFormatRule class.

Declaration

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

Optional Parameters

Name Type Default Description
modelJson any null

A JSON object used for dashboard deserialization. Do not pass this parameter directly.

serializer ModelSerializer null

An object used for dashboard deserialization. Do not pass this parameter directly.

Properties

condition Property

Specifies a condition used to apply formatting to a dashboard item.

Declaration

condition: ko.Computed<FormatConditionBase>

Property Value

Type Description
ko.Computed<FormatConditionBase>

A FormatConditionBase descendant that specifies a condition used to apply formatting to a dashboard item.

enabled Property

Declaration

enabled: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

name Property

Declaration

name: ko.Observable<string>

Property Value

Type Description
ko.Observable<string>

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

Returns

Type Description
ISerializationInfoArray

An array of objects that provide serialization info.