workbook.createConditionalFormat(options)

Note:

The content in this help topic applies to SuiteScript 2.x.

Method Description	Creates a conditional format.
Returns	workbook.ConditionalFormat
Supported Script Types	Server scripts For more information, see SuiteScript 2.x Script Types.
Governance	None
Module	N/workbook Module
Sibling Module Members	N/workbook Module Members
Since	2021.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description
options.rules	workbook.ConditionalFormatRule[]	required	The style rules to use for this conditional format.

Errors

Error Code	Thrown If
NO_RULE_DEFINED	The options.rules parameter is an empty array.

Related Topics

N/workbook Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices