workbook.SortDefinition

Object Description

A sort definition object which can be used with you create a pivot axis.

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

A sort definition object is used as a parameter in the workbook.createPivotAxis(options) method.

Supported Script Types

Server scripts

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

Module

N/workbook Module

Methods and Properties

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

Syntax

Related Topics