module function · N/workbook

createPivot()

workbook.createPivot(options)

Creates a pivot definition.

Implementation
Not started
Design
Open for proposals suggest how it should read
Proposals
A
Signature
workbook.createPivot(options)
Returns
workbook.Pivot
Governance
None
Script types
Server scripts
Version
SuiteScript 2.x, documented for 2.1; since NetSuite 2020.2
call shapefrom Oracle's parameter table
1workbook.createPivot({2    columnAxis:   /* workbook.PivotAxis, required */,3    dataset:      /* dataset.Dataset, required */,4    id:           /* string, required */,5    name:         /* string, required */,6    reportStyles: /* workbook.ReportStyle, required */,7    rowAxis:      /* workbook.PivotAxis, required */8});
Oracle reference for this method
ParameterTypeRequiredDescription
options.columnAxisworkbook.PivotAxisrequiredThe column axis (X-axis) for the pivot. This includes the fields and measures that are used on the column axis, as well as sorting behavior that is applied to the axis fields and measures.
options.datasetdataset.DatasetrequiredThe underlying dataset that the pivot is based on. A pivot can include only the data (fields) that are included in the dataset.
options.idstringrequiredThe ID of the pivot.
options.namestringrequiredThe name of the pivot.
options.reportStylesworkbook.ReportStylerequiredThe report styles for the pivot.
options.rowAxisworkbook.PivotAxisrequiredThe row axis (Y-axis) for the pivot. This includes the fields and measures that are used on the column axis, as well as sorting behavior that is applied to the axis fields and measures.
B

No Mynt syntax yet.

Nothing in the language compiles to workbook.createPivot(options) today. How should it read?

C

Competing syntax for createPivot, from GitHub Discussions. Select two or more to compare them side by side.

All discussions

Loading proposals from GitHub…

D

Write the Mynt you wish you could write.

A good proposal shows the syntax, the SuiteScript it should become, and argues for it: why it is clearer, how it fits the rest of the language, what it makes harder.

  • Clarity. Does it say what happens, without ceremony?
  • Consistency. Does it read like load, save and Ref[field]?
  • Expressiveness. Does it cover the cases people actually write?
  • Honesty. Does it hide a NetSuite cost, such as governance, that a reader should see?

N/workbook · workbook.createPivot(options)

Suggest syntax for createPivot