workbook.createSortByMeasure(options)

Note:

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

Method Description	Creates a sort based on a measure.
Returns	workbook.SortByMeasure
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.measure	workbook.Measure	required	The measure to sort by.
options.otherAxisSelector	Array<workbook.DescendantOrSelfNodesSelector | workbook.DimensionSelector | workbook.PathSelector>	required	The selector for the other axis.
options.selector	Array<workbook.DescendantOrSelfNodesSelector | workbook.DimensionSelector | workbook.PathSelector>	required	The selector for the sort.
options.sort	workbook.Sort	required	The sort used to create.

Related Topics

N/workbook Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices