PivotAxis.root

Note:

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

Property Description	The root data for the pivot axis.
Type	workbook.DataDimension | workbook.Section
Module	N/workbook Module
Parent Object	workbook.PivotAxis
Sibling Object Members	PivotAxis Object Members
Since	2020.2

Errors

Error Code	Thrown If
WRONG_PARAMETER_TYPE	The value specified for this property is not a workbook.DataDimension or a workbook.Section.

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 PivotAxis.root in a PivotDefinition
var myWorkbook = workbook.load({
    id: myWorkbookId 
});

log.audit({
    title: 'PivotDefinition PivotAxis(rowAxis) root = ',
    details: myWorkbook.pivotDefinitions[0].rowAxis.root
});

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

          

Related Topics

workbook.PivotAxis

N/workbook Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices