DashboardItemFormatRule Class

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

Declaration

export abstract class DashboardItemFormatRule extends TypedSerializableModel

Inherited Members

disposed

itemType

Inheritance

SerializableModel

TypedSerializableModel

DashboardItemFormatRule

CellsItemFormatRule

CardItemFormatRuleBase

ChartItemFormatRuleBase

constructor

Initializes a new instance of the DashboardItemFormatRule 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

condition Property

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

Declaration

condition: ko.Computed<DevExpress.Dashboard.Model.FormatConditionBase>

Property Value

Type	Description
Computed<FormatConditionBase>	A FormatConditionBase descendant that specifies a condition used to apply formatting to a dashboard item.

conditionAverage Property

Specifies a condition used to apply formatting to a dashboard item according to the average value.

Declaration

conditionAverage: DevExpress.Dashboard.Model.FormatConditionAverage

Property Value

Type	Description
FormatConditionAverage	A FormatConditionAverage object that specifies a condition used to apply formatting to a dashboard item.

conditionBar Property

Specifies a condition used to visualize numeric values using bars.

Declaration

conditionBar: DevExpress.Dashboard.Model.FormatConditionBar

Property Value

Type	Description
FormatConditionBar	A FormatConditionBar object that specifies a condition used to apply formatting to a dashboard item.

conditionDateOccuring Property

Specifies a condition used to apply formatting to date-time values concerning a specific date and/or date interval relative to today.

Declaration

conditionDateOccuring: DevExpress.Dashboard.Model.FormatConditionDateOccurring

Property Value

Type	Description
FormatConditionDateOccurring	A FormatConditionDateOccurring object that specifies a condition used to apply formatting to a dashboard item.

conditionExpression Property

Specifies a condition used to apply formatting according to the specified expression.

Declaration

conditionExpression: DevExpress.Dashboard.Model.FormatConditionExpression

Property Value

Type	Description
FormatConditionExpression	A FormatConditionExpression object that specifies a condition used to apply formatting to a dashboard item.

conditionGradientRangeBar Property

Specifies a condition used to visualize numeric values using bars whose colors are contained in the specified color gradient.

Declaration

conditionGradientRangeBar: DevExpress.Dashboard.Model.FormatConditionGradientRangeBar

Property Value

Type	Description
FormatConditionGradientRangeBar	A FormatConditionGradientRangeBar object that specifies a condition used to apply formatting to a dashboard item.

conditionRangeGradient Property

Specifies a condition used to apply formatting using value ranges and a specified color gradient.

Declaration

conditionRangeGradient: DevExpress.Dashboard.Model.FormatConditionRangeGradient

Property Value

Type	Description
FormatConditionRangeGradient	A FormatConditionRangeGradient object that specifies a condition used to apply formatting to a dashboard item.

conditionTopBottom Property

Specifies a condition used to apply formatting to top/bottom values.

Declaration

conditionTopBottom: DevExpress.Dashboard.Model.FormatConditionTopBottom

Property Value

Type	Description
FormatConditionTopBottom	A FormatConditionTopBottom object that specifies a condition used to apply formatting to a dashboard item.

conditionValue Property

Specifies a condition used to apply formatting according to predefined values.

Declaration

conditionValue: DevExpress.Dashboard.Model.FormatConditionValue

Property Value

Type	Description
FormatConditionValue	A FormatConditionValue object 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

Specifies the name of the current format rule.

Declaration

name: ko.Observable<string>

Property Value

Type	Description
Observable<string>	A string that specifies the name of the current format rule.

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

Returns

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