Conditional format object is used for defining conditional formatting rules.

Properties

Name Type Description
formula String Condition rule. Can include AND, OR, ==, !=, >, >=, <,<=, -, +, *, /, isNaN(), !isNaN(). #value is used for referring to the value of the cell in the condition. Example: '#value > 3'.
format Object Style object applied if the cell value meets the condition. Set color value as hex color codes. This is important for exports to PDF and Excel.
id Number optional Identifier in the conditional formatting rule. If id is not specified, the id for the rule is set inside the component automatically.
row Number optional Row index where the condition is applied.
column Number optional Column index where the condition is applied.
measure String optional Measure name to which the condition will be applied.
hierarchy String optional Hierarchy name where the condition is applied.
member String optional Member name where the condition is applied.
isTotal Boolean optional If undefined, the condition will affect all cells. If true, the condition affects subtotals and totals cells alone. If false it affects only the regular cells.

Example

Add conditional formatting rule: