Legend.root

Property Description

The root data (that is, fields) that defines the legend.

Type

workbook.DataDimension | workbook.Section

Module

N/workbook Module

Parent Object

workbook.Legend

Sibling Object Members

Legend Object Members

Since

2020.2

Errors

Error Code

Thrown If

WRONG_PARAMETER_TYPE

The value specified for this property is not a workbook.DataDimension or a workbook.Section.

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
...
// View Legend.root in a Chart
var myWorkbook = workbook.load({
    id: myWorkbookId 
});

log.audit({
    title: 'Legend.root = ',
    details: myWorkbook.charts[0].legend.root
});
...
// Add additional code 

          

Related Topics

General Notices