DashboardItemFormatRule Class
A format rule used to apply conditional formatting to dashboard items.
Declaration
export abstract class DashboardItemFormatRule extends TypedSerializableModel
Inherited Members
Inheritance
constructor
Initializes a new instance of the DashboardItemFormatRule
class.
Declaration
constructor(
modelJson?: any,
serializer?: 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
condition Property
Specifies a condition used to apply formatting to a dashboard item.
Declaration
condition: ko.Computed<FormatConditionBase>
Property Value
Type | Description |
---|---|
Computed<FormatConditionBase> | A FormatConditionBase descendant that specifies a condition used to apply formatting to a dashboard item. |
enabled Property
Specifies whether the current format rule is enabled.
Declaration
enabled: ko.Observable<boolean>
Property Value
Type | Description |
---|---|
Observable<boolean> | true, if the current format rule is enabled; otherwise, false. |
name Property
Declaration
name: ko.Observable<string>
Property Value
Type |
---|
Observable<string> |
Methods
getInfo Method
For internal use.
Declaration
getInfo(): ISerializationInfoArray
Returns
Type | Description |
---|---|
ISerializationInfoArray | An array of objects that provide serialization info. |