Conditional Formatting Rules

Conditional formatting rules help you highlight important data in your workbook visualizations based on criteria you set. For instance, you can customize cell backgrounds, font sizes, styles, and more.

For more information about conditional formatting in SuiteAnalytics Workbook, see Conditional Formatting.

You can create a conditional formatting rule using workbook.createConditionalFormatRule(options). This method creates a workbook.ConditionalFormatRule object. To create a rule, you'll need to provide these parameters:

Use both parameters to create a conditional formatting rule:

          var myRule = workbook.createConditionalFormatRule({
    filter: myFilter,
    style: myStyle
}); 

        

Once you have your rules, use workbook.createConditionalFormat(options) to combine them into a single workbook.ConditionalFormat object:

          var myConditionalFormat = workbook.createConditionalFormat({
    rules: [myFirstRule, mySecondRule]
}); 

        

To apply the rules to a column, pass a workbook.ConditionalFormat object to workbook.createTableColumn(options). For more information, see Table Columns.

          var myTableColumn = workbook.createTableColumn({
    datasetColumnAlias: 'MyColumn',
    conditionalFormats: [myFirstConditionalFormat, mySecondConditionalFormat]
}); 

        

Related Topics

General Notices