workbook.createSortByDataDimensionItem(options)

Note:

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

Method Description	Creates a sort based on data dimension items.
Returns	workbook.SortByDataDimensionItem
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	2021.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description
options.item	workbook.DataDimensionItem	required	The data dimension items to sort by.
options.sort	workbook.Sort	required	The sort to use, which defines sort behavior such as whether to sort ascending or descending, whether the sort is case sensitive, and so on.

Related Topics

N/workbook Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices