SortDefinition.sortBys

Note:

The content in this help topic applies to SuiteScript 2.x.

Property Description	The ordering elements for the sort definition.
Type	Array<workbook.DimensionSort | workbook.MeasureSort>
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 specified for this property is not a workbook.DimensionSort[] or a workbook.MeasureSort[].

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.

            // Add additional code
...
var mySortDefinition = workbook.createSortDefinition({
    selector: myDimensionSelector,
    sortBys: [myDimensionSort]
});

var theSortBys = mySortDefinition.sortBys;
...
// Add additional code 

          

Related Topics

workbook.SortDefinition

N/workbook Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices