workbook.createLegend(options)
|
Method Description |
Creates a chart legend. |
|
Returns |
|
|
Supported Script Types |
Server scripts For more information, see SuiteScript 2.x Script Types. |
|
Governance |
None |
|
Module |
|
|
Sibling Module Members |
|
|
Since |
2020.2 |
Parameters
The options parameter is a JavaScript object.
|
Parameter |
Type |
Required / Optional |
Description |
|---|---|---|---|
|
|
required |
The axes for the legend. |
|
|
|
required |
The data for the legend. |
|
|
|
optional |
The sort definition for the corresponding legend axes. |
Syntax
The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/workbook Module Script Samples. Also see Full scripts in the Tutorial: Creating a Workbook Using the Workbook API topic.
// Add additional code
...
// Create a basic Legend based on a Section
var myLegend = workbook.createLegend({
axes: [myChartAxis],
root: mySection
});
// Create a basic Legend based on a DataDimension
var myLegend = workbook.createLegend({
axes: [myChartAxis],
root: myDataDimension
});
// Create a sorted Legend
var myLegend = workbook.createLegend({
axes: [myChartAxis],
root: mySection,
sortDefinitions: [mySortDefinition]
});
...
// Add additional code