Workbook.runPivot(options)
Method Description |
Runs the pivot and returns an array of pivot intersections. |
Returns |
|
Supported Script Types |
Server scripts For more information, see SuiteScript 2.x Script Types. |
Governance |
10 units for each intersection returned |
Module |
|
Parent Object |
|
Sibling Object Members |
|
Since |
2021.2 |
Parameters
Parameter |
Type |
Required / Optional |
Description |
---|---|---|---|
|
string |
required |
The ID of the pivot. |
Errors
Error Code |
Thrown If |
---|---|
|
The pivot specified by the |
Syntax
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 myWorkbook = workbook.load({
id: myWorkbookId,
});
var myResultSet = myWorkbook.runPivot({
id: myTableId,
});
log.debug({
title: 'My Run Pivot Result Set: ',
details: myResultSet
});
...
// Add additional code