module function · N/workbook
createPivot()
workbook.createPivot(options)
Creates a pivot definition.
- Implementation
- Not started
- Design
- Open for proposals suggest how it should read
A
suitescript api
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});
| Parameter | Type | Required | Description |
|---|---|---|---|
| options.columnAxis | workbook.PivotAxis | required | The 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.dataset | dataset.Dataset | required | The underlying dataset that the pivot is based on. A pivot can include only the data (fields) that are included in the dataset. |
| options.id | string | required | The ID of the pivot. |
| options.name | string | required | The name of the pivot. |
| options.reportStyles | workbook.ReportStyle | required | The report styles for the pivot. |
| options.rowAxis | workbook.PivotAxis | required | The 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
mynt syntax
No Mynt syntax yet.
Nothing in the language compiles to workbook.createPivot(options) today. How should it read?
C
community proposals
Competing syntax for createPivot, from GitHub Discussions. Select two or more to compare them side by side.
Loading proposals from GitHub…
D
suggest an alternative
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,saveandRef[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?