SortDefinition.sortBys
|
Property Description |
The ordering elements for the sort definition. |
|
Type |
Array<workbook.SortByDataDimensionItem | workbook.SortByMeasure> |
|
Module |
|
|
Parent Object |
|
|
Sibling Object Members |
|
|
Since |
2020.2 |
Errors
|
Error Code |
Thrown If |
|---|---|
|
|
The value for this parameter is not a workbook.SortByDataDimensionItem or a workbook.SortByMeasure. |
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 mySortDefinition = workbook.createSortDefinition({
selector: myDimensionSelector,
sortBys: [myDimensionSort]
});
var theSortBys = mySortDefinition.sortBys;
...
// Add additional code