Modules

filter

 

Objects/Functions

module (N/workbook)

SuiteScript 2.0

workbook.createPivotDefinition(options)

{workbook}.createPivotDefinition({aggregationFilters: {Array},columnAxis: {workbook.PivotAxis*},dataset: {dataset.Dataset*},filterExpressions: {workbook.Expression[]},id: {string*},name: ${7:string*},rowAxis: ${8:workbook.PivotAxis*}})

N/workbook Module
workbook.createPivotDefinition()
Method Description: Creates 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. A pivot definition is based on an underlying dataset and can include an ID, a name, a row axis, a column axis, conditional/limiting filters, and filter expressions.
Returns: workbook.PivotDefinition
Supported Script Types: Server scripts For more information, see SuiteScript 2.0 Script Types.
Governance: None
Module: N/workbook Module
Sibling Module Members: N/workbook Module Members
Since: 2020.2
Search NetSuite - https://system.netsuite.com/app/help/helpcenter.nl?search=workbook.createPivotDefinition(options)

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]
});
//...
// Add additional code

//SOURCE: https://system.netsuite.com/app/help/helpcenter.nl?fid=section_159051610759.html