workbook.SortByMeasure

Object Description

A sort based on a measure.

Use workbook.createSortByMeasure(options) to create this object.

Supported Script Types

Server scripts

For more information, see SuiteScript 2.x Script Types.

Module

N/workbook Module

Methods and Properties

SortByMeasure Object Members

Since

2021.2

Syntax

Important:

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
...
//mySortByMeasure is a workbook.SortByMeasure object

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

Syntax

Related Topics