workbook.ConditionalFormat

Object Description

A set of conditional formatting rules.

Use workbook.createConditionalFormat(options) to create this object.

A conditional format object is used as a parameter in the workbook.createPivot(options) and workbook.createTableColumn(options) methods.

Supported Script Types

Server scripts

For more information, see SuiteScript 2.x Script Types.

Module

N/workbook Module

Methods and Properties

ConditionalFormat Object Members

Since

2021.2

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/workbook Module Script Samples. Also see Full scripts in the Tutorial: Creating a Workbook Using the Workbook API topic.

            // Add additional code
...
//myConditionalFormat is a workbook.ConditionalFormat object

var myConditionalFormat = workbook.createConditionalFormat({
    rules: [formatrules]   // array of previously created workbook.ConditionalFormatRule
});
...
// Add additional code

Syntax

Related Topics