workbook.Legend

Object Description

A legend object which can be used when you create a chart definition.

Use workbook.createLegend(options) to create this object.

Supported Script Types

Server scripts

For more information, see SuiteScript 2.x Script Types.

Module

N/workbook Module

Methods and Properties

Legend Object Members

Since

2020.2

Syntax

Important:

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]
});

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

// Note that some Legend properties may be empty/null based on the loaded workbook
var myLegend = myWorkbook.charts[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

Syntax

Related Topics