workbook.createSortByMeasure(options)
|
Method Description |
Creates a sort based on a measure. |
|
Returns |
|
|
Supported Script Types |
Server scripts For more information, see SuiteScript 2.x Script Types. |
|
Governance |
None |
|
Module |
|
|
Sibling Module Members |
|
|
Since |
2021.2 |
Parameters
The options parameter is a JavaScript object.
|
Parameter |
Type |
Required / Optional |
Description |
|---|---|---|---|
|
|
required |
The measure to sort by. |
|
|
|
Array< workbook.DescendantorSelfNodesSelector | workbook.DimensionSelector | workbook.PathSelector> |
required |
The selector for the other axis. |
|
|
Array< workbook.DescendantorSelfNodesSelector | workbook.DimensionSelector | workbook.PathSelector> |
required |
The selector for the sort. |
|
|
required |
The sort used to create. |
Syntax
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 mySortByMeasure = workbook.createSortByMeasure({
measure: myWorkbookMeasure, // previously created workbook.Measure object
otherAxisSelector: myAxisSelector, // previously created workbook.DescendantorSelfNodesSelector, workbook.DimensionSelector, or workbook.PathSelector object
selector: mySelector, // previously created workbook.DescendantorSelfNodesSelector, workbook.DimensionSelector, or workbook.PathSelector object
sort: mySort // previously created workbook.Sort object
});
...
// Add additional code