Legend.sortDefinitions

Property Description

The sort definitions of the legend.

Type

workbook.SortDefinition[]

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.SortDefinition[].

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

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

          

Related Topics

General Notices