workbook.DimensionSort

Object Description

A dimension sort object which can be used to create a sort definition or a limiting filter.

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

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

Supported Script Types

Server scripts

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

Module

N/workbook Module

Methods and Properties

DimensionSort 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 myDimensionSort = workbook.createDimensionSort({
    item: myDataDimensionItem,
    sort: mySort
});
...
// Add additional code

Syntax

Related Topics