workbook.createPivotAxis(options)

Note:

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

Method Description	Creates a pivot axis, which includes a data root and a sort definition.
Returns	workbook.PivotAxis
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.root	workbook.DataDimension | workbook.Section	required	The data for the pivot axis.
options.sortDefinitions	workbook.SortDefinition[]	optional	The sorting definition for the pivot axis.

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
...
// 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 

          

Related Topics

N/workbook Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices