ConditionalFormat Object Members for Dynamic Workbooks

The ConditionalFormat object in SuiteScript is essential for creating dynamic workbook visualizations through conditional formatting rules. This allows developers to enhance data presentation based on specific criteria, making reports more accessible and insightful.

What is the ConditionalFormat Object?

The ConditionalFormat object encapsulates a set of formatting rules that can be applied to workbook data. Developers commonly use this object within SuiteScript to create visually impactful analytics by applying conditions to data cells.

How to Create a ConditionalFormat Object

You can create a ConditionalFormat object using the workbook.createConditionalFormat(options) method. This method requires configuration options that specify the formatting rules to be applied.

Syntax Example

Below is a sample syntax of creating a ConditionalFormat object:

// myConditionalFormat is a workbook.ConditionalFormat object
var myConditionalFormat = workbook.createConditionalFormat({
    rules: [formatrules]   // array of previously created workbook.ConditionalFormatRule
});

Properties of ConditionalFormat

The main property of the ConditionalFormat object is:

Supported Script Types

The ConditionalFormat object is supported in server scripts, enabling back-end manipulations and data definitions for workbook presentations.

Error Handling

When utilizing the ConditionalFormat object, it's essential to handle errors effectively:

• NO_RULE_DEFINED: Indicates that the rules property is an empty array, meaning no conditions are set.
• WRONG_PARAMETER_TYPE: This error occurs if you pass a parameter that isn't an array of workbook.ConditionalFormatRule objects.

Who This Affects

This information is crucial for:

• Developers: Who implement advanced data visualizations in SuiteScript.
• System Administrators: Responsible for maintaining workbook functionalities.

Key Takeaways

• The ConditionalFormat object allows the application of dynamic formatting rules in workbook data presentations.
• The rules property defines specific formatting conditions for data cells.
• Understanding error codes is essential for debugging when working with ConditionalFormat objects.