The requested page is not available for the requested platform. You are viewing the content for Default platform.

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?: DxDesigner.Analytics.Utils.ModelSerializer)

Optional Parameters

Name Type Default Description
modelJson any null

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

serializer DxDesigner.Analytics.Utils.ModelSerializer null

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

Properties

condition Property

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

Declaration

condition: KnockoutComputed<FormatConditionBase>

Property Value

Type Description
KnockoutComputed<FormatConditionBase>

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

enabled Property

Declaration

enabled: KnockoutObservable<boolean>

Property Value

Type Description
KnockoutObservable<boolean>

name Property

Declaration

name: KnockoutObservable<string>

Property Value

Type Description
KnockoutObservable<string>

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationsInfo

Returns

Type Description
DxDesigner.Analytics.Utils.ISerializationsInfo