IConditionalFormatting
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Conditional-formatting settings: an on/off toggle plus the ordered list of rules. Stored on the table config and (when persisted) on the insight’s properties.controls.conditionalFormatting.
export interface IConditionalFormatting
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (ALPHA) | ||
(ALPHA) | |||
(ALPHA) (Optional) Targets whose formatting is explicitly suppressed — turned off rather than inherited from any semantic-layer conditional formatting carried on the execution result (see ISemanticConditionalFormatting). A target listed here shows no formatting even if the semantic layer has rules for it. A target not listed here (or when this is absent) is Inherited: semantic rules apply as-is. | |||
string | (ALPHA) (Optional) Model version of the persisted shape (mirrors the dashboard model-version convention). Absent is treated as |
Property details
IConditionalFormatting.enabledpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
enabled: boolean;
IConditionalFormatting.rulespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
rules: IConditionalFormattingRule[];
IConditionalFormatting.suppressedTargetspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Targets whose formatting is explicitly suppressed — turned off rather than inherited from any semantic-layer conditional formatting carried on the execution result (see ISemanticConditionalFormatting). A target listed here shows no formatting even if the semantic layer has rules for it. A target not listed here (or when this is absent) is Inherited: semantic rules apply as-is.
suppressedTargets?: ConditionalFormattingTarget[];
IConditionalFormatting.versionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Model version of the persisted shape (mirrors the dashboard model-version convention). Absent is treated as "1". Lets the persisted contract evolve for cross-stack readers (e.g. server XLSX export) without breaking older saved insights.
version?: string;