Pivot.id

Note:

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

Property Description

The ID of the pivot definition.

Type

string

Module

N/workbook Module

Parent Object

workbook.Pivot

Sibling Object Members

Pivot Object Members

Since

2020.2

Errors

Error Code

Thrown If

WRONG_PARAMETER_TYPE

The value for this property is not a string.

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
...
// View the PivotDefinition's id
var myWorkbook = workbook.load({
    id: myWorkbookId 
});

log.audit({
    title: 'PivotDefinition id = ',
    details: myWorkbook.pivotDefinitions[0].id
});
...
// Add additional code 

          

Related Topics

workbook.Pivot
N/workbook Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices