workbook.Workbook

Note:

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

Object Description

A workbook. Workbooks are where you analyze the results of your dataset queries using different components, such as table views and pivots. All workbooks are based on a dataset, and a single dataset can be used as the basis for multiple workbooks. A workbook can include tables and pivots.

A workbook is created using workbook.create(options).

Supported Script Types

Server scripts

For more information, see SuiteScript 2.x Script Types.

Module

N/workbook Module

Methods and Properties

Workbook Object Members

Since

2020.2

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.

            / Add additional code
...
var myWorkbook = workbook.create({
    description: 'A sample workbook',
    name: 'My Workbook',
    pivots: [myPivot],
    tables: [myTable]
});
...
// Add additional code

Syntax

Related Topics