workbook.createConditionalFormatRule(options)
Method Description |
Creates a conditional format rule. |
Returns |
|
Supported Script Types |
Server scripts For more information, see SuiteScript 2.x Script Types. |
Governance |
None |
Module |
|
Sibling Module Members |
|
Since |
2021.2 |
Parameters
The options
parameter is a JavaScript object.
Parameter |
Type |
Required / Optional |
Description |
---|---|---|---|
|
required |
A filter indicating when the conditional format rule should be applied. |
|
|
required |
The style to use for the conditional format rule. |
Syntax
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
...
var myConditionalFormatRule = workbook.createConditionalFormatRule({
filter: formatFilter, // previously created workbook.TableColumnFilter
style: formatStyle // previously created workbook.Style
});
...
// Add additional code