workbook.createSortByDataDimensionItem(options)
Method Description |
Creates a sort based on data dimension items. |
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 data dimension items to sort by. |
|
|
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. |
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 mySortByDataDimensionItem = workbook.createSortByDataDimensionItem({
item: myDataDimensionItem, // previously created workbook.DataDimensionItem object
sort: SORT.ASCENDING
});
...
// Add additional code