module function · N/workbook
createLegend()
workbook.createLegend(options)
Creates a chart legend.
- Implementation
- Not started
- Design
- Open for proposals suggest how it should read
A
suitescript api
1workbook.createLegend({2 axes: /* workbook.ChartAxis [], required */,3 root: /* workbook.Section | workbook.DataDimension, required */,4 sortDefinitions: /* workbook.SortDefinition [], optional */5});| Parameter | Type | Required | Description |
|---|---|---|---|
| options.axes | workbook.ChartAxis [] | required | The axes for the legend. |
| options.root | workbook.Section | workbook.DataDimension | required | The data for the legend. |
| options.sortDefinitions | workbook.SortDefinition [] | optional | The sort definition for the corresponding legend axes. |
B
mynt syntax
No Mynt syntax yet.
Nothing in the language compiles to workbook.createLegend(options) today. How should it read?
C
community proposals
Competing syntax for createLegend, 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?