ReportStyle Object Members

The ReportStyle object provides a way to define the formatting and structure of reports in SuiteScript. Understanding its members is crucial for developers looking to implement customized reports effectively.

What is the ReportStyle Object?

The ReportStyle object allows developers to define styles that customize how data is presented in reports. You can create this object using the workbook.createReportStyle(options) method, which serves as a parameter in report creation methods like workbook.createPivot(options).

Key Members of ReportStyle Object

Here are the members available within the ReportStyle object:

Detailed Descriptions

• ReportStyle.rules: This property holds an array of ReportStyleRule objects defining the formatting rules for the specific report style. Ensure that the rules are populated appropriately to avoid errors such as NO_RULE_DEFINED, which occurs when the rule array is empty.
• ReportStyle.selectors: This property contains an array of MeasureValueSelector objects used to manage selector aspects of the report style. Improper setups may lead to errors if the array does not contain valid selector objects.

Syntax Example

The following syntax demonstrates how to create a ReportStyle object:

// Create an instance of a report style
var myReportStyle = workbook.createReportStyle({
    selectors: [measureValueSelector],  // Refer to previously created MeasureValueSelector objects
    rules: [rule]                       // Refer to previously created ReportStyleRule objects
});

Supported Script Types

• This object is supported in Server scripts, allowing developers to leverage this functionality in various reporting scenarios.

Error Handling

Errors can arise when using the ReportStyle object if the defined input parameters do not meet the expected type requirements. For instance:

• NO_RULE_DEFINED: Thrown if the value for the rules property is an empty array.
• WRONG_PARAMETER_TYPE: Triggered when the rules property does not consist of an array of ReportStyleRule objects.

Who This Affects

This documentation primarily impacts the following roles:

• Developers: Utilizing the ReportStyle object to create customized reports.
• Administrators: Setting up reporting functionalities within NetSuite.

Key Takeaways

• The ReportStyle object is essential for customizing report formats in NetSuite.
• Its members, including rules and selectors, determine presentation and data selection.
• Proper error handling is crucial to ensure valid configurations of report styles.