ISemanticConditionalFormatting
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Conditional-formatting rules authored once on a semantic-layer catalog object (label, metric, fact, or date dataset) and carried on the matching execution result header (attributeHeader.conditionalFormatting / measureHeaderItem.conditionalFormatting) so every insight built on that object inherits them without re-authoring. Unlike IConditionalFormatting, there is no per-rule target — the target is implicit (the header the rules arrived on) and there is no rule grouping, only a flat, first-match-wins condition list.
export interface ISemanticConditionalFormatting
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) | |||
boolean | (ALPHA) (Optional) Whether the rules are applied when rendering. Absent is treated as | ||
string | (ALPHA) (Optional) Model version of the persisted shape. Absent is treated as |
Property details
ISemanticConditionalFormatting.conditionspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
conditions: IConditionalFormattingCondition[];
ISemanticConditionalFormatting.enabledpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Whether the rules are applied when rendering. Absent is treated as true — this lets the object be turned off without deleting the authored conditions, distinct from having no rules at all.
enabled?: boolean;
ISemanticConditionalFormatting.versionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Model version of the persisted shape. Absent is treated as "1".
version?: string;