Modules
Objects/Functions
SuiteScript 2.0
// Please search https://system.netsuite.com/app/help/helpcenter.nl?search=workbook.PivotDefinition for more information.
N/workbook Module
workbook.PivotDefinition
Object Description:
A pivot definition. A pivot is a workbook component that enables you to pivot your dataset query results by defining measures and dimensions, so that you can analyze different subsets of data.
You can create a pivot definition using workbook.createPivotDefinition(options).
Supported Script Types:
Server scripts
For more information, see SuiteScript 2.0 Script Types.
Module:
N/workbook Module
Methods and Properties:
PivotDefinition Object Members
Since:
2020.2
Search NetSuite -
https://system.netsuite.com/app/help/helpcenter.nl?search=workbook.PivotDefinition
Example:
// Code Example 1
// Add additional code
//...
// Create a basic PivotDefinition
var myPivotDefinition = workbook.createPivotDefinition({
name: 'My Pivot Definition',
id: '_myPivotDefinition',
rowAxis: myRowPivotAxis,
columnAxis: myColumnPivotAxis,
dataset: myDataset
});
// Create a comprehensive PivotDefinition with Expressions
var myPivotDefinition = workbook.createPivotDefinition({
name: 'My Pivot Definition',
id: '_myPivotDefinition',
rowAxis: myRowPivotAxis,
columnAxis: myColumnPivotAxis,
dataset: myDataset,
filterExpressions: [myExpression]
});
// Create a comprehensive PivotDefinition with LimitingFilters
var myPivotDefinition = workbook.createPivotDefinition({
name: 'My Pivot Definition',
id: '_myPivotDefinition',
rowAxis: myRowPivotAxis,
columnAxis: myColumnPivotAxis,
dataset: myDataset,
filterExpressions: [myExpression],
aggregationFilters: [myLimitingFilter]
});
// Create a comprehensive PivotDefinition with ConditionalFilters
var myPivotDefinition = workbook.createPivotDefinition({
name: 'My Pivot Definition',
id: '_myPivotDefinition',
rowAxis: myRowPivotAxis,
columnAxis: myColumnPivotAxis,
dataset: myDataset,
filterExpressions: [myExpression],
aggregationFilters: [myConditionalFilter]
});
// View a workbook.PivotDefinition
var myWorkbook = workbook.load ({
id: myWorkbookId
});
var myPivotDefinition = myWorkbook.pivotDefinitions[0];
// Note that some PivotDefinition properties may be empty/null based on the loaded workbook
log.audit({
title: 'PivotDefinition id = ',
details: myPivotDefinition.id
});
log.audit({
title: 'PivotDefinition name = ',
details: myPivotDefinition.name
});
log.audit({
title: 'PivotDefinition rowAxis = ',
details: myPivotDefinition.rowAxis
});
log.audit({
title: 'PivotDefinition columnAxis = ',
details: myPivotDefinition.columnAxis
});
log.audit({
title: 'PivotDefinition dataset = ',
details: myPivotDefinition.dataset
});
log.audit({
title: 'PivotDefinition filterExpressions = ',
details: myPivotDefinition.filterExpressions
});
log.audit({
title: 'PivotDefinition aggregationFilters = ',
details: myPivotDefinition.aggregationFilters
});
//...
// Add additional code
//SOURCE: https://system.netsuite.com/app/help/helpcenter.nl?fid=section_159008434619.html