SortDefinition.selector

Property Description

The selector for the sort definition.

Type

workbook.DimensionSelector | workbook.PathSelector

Module

N/workbook Module

Parent Object

workbook.SortDefinition

Sibling Object Members

SortDefinition Object Members

Since

2020.2

Errors

Error Code

Thrown If

WRONG_PARAMETER_TYPE

The value for this property is not a boolean.

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
...
var mySortDefinition = workbook.createSortDefinition({
    selector: myDimensionSelector,
    sortBys: [myDimensionSort]
});

var theSelector = mySortDefinition.selector;
...
// Add additional code 

          

Related Topics

General Notices