IConditionalFormatting

Home > @gooddata/sdk-model > IConditionalFormatting

IConditionalFormatting interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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.

Signature:

export interface IConditionalFormatting 

Properties

Property	Modifiers	Type	Description
customTargets?		readonly ConditionalFormattingTarget[]	(ALPHA) (Optional) Targets for which these insight-level rules take over entirely from any semantic-layer conditional formatting carried on the execution result (see ISemanticConditionalFormatting). A target listed here is Custom: its semantic rules are ignored, never merged. A target not listed here (or when this is absent) is Inherited: semantic rules apply as-is.
enabled		boolean	(ALPHA)
rules		readonly IConditionalFormattingRule[]	(ALPHA)
version?		string	(ALPHA) (Optional) 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.