1.Conditional formatting

Conditional formatting allows highlighting cells depending on their values. You can create as many conditions with different formatting for one report as you need, there is no limit towards the number of conditions. If there are more than one conditional formatting rules for the report, they will be applied one by one in the order they have been created.

The conditional formatting may be added to all pivot table cells, to the cell specifying row and column indexes, to totals and subtotals only, to regular cells only, or to the cells of selected measure, hierarchy, and hierarchy’s member.

Conditions can be defined within a report. When you save the report all the conditional formatting will be saved as well and loaded when the report is retrieved.

More details about conditional formatting are available in the following sections:

Conditional format properties
Style object format
Conditional formatting for all values
Conditional formatting for specific values
Change conditional formatting using Toolbar

Conditional format properties

With conditional formatting, you can define a logical expression for condition rules, style objects for matched cells, and application range for conditions. Style objects are composed of font size, font color, font family and background color.

Here is a list of all available properties for conditions:

formula – condition that can contain AND, OR, ==, !=, >, <, >=, <=, +, -, *, /, isNaN(), !isNaN(). #value is used to address the cell value in condition. Example: '#value > 2'.
format – style object that will be applied to a cell if the condition for the cell value is met. Please note that for export to Excel and PDF colors should be set as hex color codes.
formatCSS (optional) – String. Represents ready to use CSS string of format style object. format style object has properties with names that differ from CSS. The component transforms format to formatCSS.
id (optional) – id of the conditional formatting rule. If id property is not set, the id for the rule will be set inside Pivot component.
row (optional) – row index to which the condition should be applied.
column (optional) – column index to which the condition should be applied.
measure (optional) – measure unique name to which the condition should be applied.
hierarchy (optional) – hierarchy unique name to which the condition should be applied.
member (optional) – member unique name to which the condition should be applied.
isTotal (optional) – Boolean. If it is not defined, the condition will be applied to all cells. If it is true, the condition will be applied to totals and subtotals cells only. If it is false, the condition will be applied to regular cells only.

Style object format

format is a style object that can have the following properties:

"format": {
    "backgroundColor": "#FFFFFF",
    "color": "#0000FF",
    "fontFamily": "Arial",
    "fontSize": "12px"
}

You can specify only necessary properties.

In case you want to export the pivot table to Excel and PDF don’t forget to set colors as hex color codes.

Conditional formatting for all values

You need to specify properties formula and format to apply the conditional rule to all values. You can define format the following way:

{
    "dataSource": {
        "filename": "http://www.flexmonster.com/download/data.csv"
    },
    "conditions": [
        {
            "formula": "#value < 400000",
            "format": {
                "backgroundColor": "#FFFFFF",
                "color": "#0000FF",
                "fontFamily": "Arial",
                "fontSize": "12px"
            }
        }
    ]
}

Open the example on JSFiddle.

Conditional formatting for specific values

The formatting rule can be applied to a specific measure, hierarchy, hierarchy member, column or row. Also, you can apply it only to regular cells or totals and subtotals. For example, if you are visualizing financial data, you may want to apply conditional formatting only to regular cells with prices. Please see an example below:

{
    "dataSource": {
        "filename": "http://www.flexmonster.com/download/data.csv"
    },
    "conditions": [
        {
            "formula": "#value < 400000",
            "measure": "Price",
            "isTotal": false,
            "format": {
                "backgroundColor": "#FFFFFF",
                "color": "#0000FF",
                "fontFamily": "Arial",
                "fontSize": "12px"
            }
        }
    ],
    "slice": {
        "rows": [ {"uniqueName": "Category"} ],
        "measures": [
            {"uniqueName": "Price"},
            {"uniqueName": "Quantity"}
        ]
    }
}

Open the example on JSFiddle.

Please use Format > Conditional formatting in Toolbar to change/define conditional formatting for values in run time.

This conditional formatting will be applied to the specified values and will be saved within the report.

Сonditional formatting via API

API call addCondition() is used to add or change the conditional formatting rule in run time. You can change conditions among with other report parts using API call setReport().

1.