workbook.DimensionSelector

Object Description

A dimension selector object which is used when you create a path selector, a sort definition, a conditional filter, a limiting filter or a measure sort.

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

A dimension selector object is used as a parameter in these methods: workbook.createConditionalFilter(options), workbook.createLimitingFilter(options), workbook.createMeasureSort(options), workbook.createMeasureValueSelector(options) , workbook.createPathSelector(options), workbook.createSortByMeasure(options), and workbook.createSortDefinition(options).

Supported Script Types

Server scripts

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

Module

N/workbook Module

Methods and Properties

DimensionSelector Object Members

Since

2020.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
...
var myDimensionSelector = workbook.createDimensionSelector({
    dimension: myDataDimension
});
...
// Add additional code

Syntax

Related Topics