workbook.createPivotAxis(options)
Method Description |
Creates a pivot axis, which includes a data root and a sort definition. |
Returns |
|
Supported Script Types |
Server scripts For more information, see SuiteScript 2.x Script Types. |
Governance |
None |
Module |
|
Sibling Module Members |
|
Since |
2020.2 |
Parameters
The options
parameter is a JavaScript object.
Parameter |
Type |
Required / Optional |
Description |
---|---|---|---|
|
required |
The data for the pivot axis. |
|
|
optional |
The sorting definition for the pivot axis. |
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
...
// Create a basic Section-based PivotAxis
var myPivotAxis = workbook.createPivotAxis({
root: mySection
});
// Create a basic DataDimension-based PivotAxis
var myPivotAxis = workbook.createPivotAxis({
root: myDataDimension
});
// Create a sorted Section-based PivotAxis
var myPivotAxis = workbook.createPivotAxis({
root: mySection,
sortDefinitions: [mySortDefinition]
});
// Create a sorted DataDimension-based PivotAxis
var myPivotAxis = workbook.createPivotAxis({
root: myDataDimension,
sortDefinitions: [mySortDefinition]
});
...
// Add additional code