workbook.createDimensionSort(options)

Note:

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

Method Description	Creates a dimension sort.
Returns	workbook.DimensionSort
Supported Script Types	Server scripts For more information, see SuiteScript 2.x Script Types.
Governance	None
Module	N/workbook Module
Sibling Module Members	N/workbook Module Members
Since	2020.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description
options.item	workbook.DataDimensionItem	required	The item of the dimension sort (the item to sort by).
options.sort	workbook.Sort	required	The sort of the dimension sort.

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

          

Related Topics

N/workbook Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices