1. SuiteCloud Platform
  2. SuiteScript
  3. SuiteScript 2.x API Reference
  4. SuiteScript 2.x Modules
  5. N/workbook Module
  6. workbook.createReportStyle(options)

workbook.createReportStyle(options)

Method Description

Creates a report style.

Returns

workbook.ReportStyle

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.ReportStyleRule[]

required

The report style rules to apply to the report style.

options.selectors

workbook.MeasureValueSelector[]

required

Selectors indicating where to apply the report style.

Errors

Error Code

Thrown If

NO_RULE_DEFINED

The options.rules parameter is an empty array.

NO_SELECTORS_DEFINED

The options.selectors parameter is an empty array.

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
...
var reportStyle = workbook.createReportStyle({
    selectors: [measureValueSelector],  // previously created workbook.MeasureValueSelector objects
    rules: [rule]                       // previously created workbook.ReportStyleRule objects
});
...
// Add additional code

Related Topics

General Notices