workbook.createTable(options)

Method Description

Creates a table view.

Returns

workbook.Table

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

2020.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter

Type

Required / Optional

Description

options.columns

workbook.TableColumn[]

required

The columns to include in the table view.

options.dataset

dataset.Dataset

required

The dataset containing the columns to include in the table view.

options.id

string

required

The ID of the table view.

options.name

string | workbook.Expression

required

The name of the table view.

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 myTable = nWorkbook.createTable({
    columns: [column1, column2], // previously defined workbook.TableColumn objects
    dataset: myDataset           // previously defined dataset
    id: 'myTableId'   
    name: 'myTableName'
});
...
//Add additional code 

          

Related Topics

General Notices