Modules

filter

 

Objects/Functions

module (N/workbook)

SuiteScript 2.0

workbook.Legend

// Please search https://system.netsuite.com/app/help/helpcenter.nl?search=workbook.Legend for more information.

N/workbook Module
workbook.Legend
Object Description: A legend. A legend can be used when you create a chart definition. You can create a legend using workbook.createLegend(options).
Supported Script Types: Server scripts For more information, see SuiteScript 2.0 Script Types.
Module: N/workbook Module
Methods and Properties: Legend Object Members
Since: 2020.2
Search NetSuite - https://system.netsuite.com/app/help/helpcenter.nl?search=workbook.Legend

Example:

// Code Example 1
// 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]
});

// View a workbook.Legend used in a ChartDefinition
var myWorkbook = workbook.load ({
id: myWorkbookId
});

// Note that some Legend properties may be empty/null based on the loaded workbook
var myLegend = myWorkbook.chartDefinitions[0].legend;
log.audit({
title: 'Legend.axes = ',
details: myLegend.axes
});
log.audit({
title: 'Legend.root = ',
details: myLegend.root
});
log.audit({
title: 'Legend.sortDefinitions = ',
details: myLegend.sortDefinitions
});
//...
// Add additional code

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