workbook.createDimensionSelector(options)

Note:

The content in this help topic applies to SuiteScript 2.x.

Method Description

Creates a dimension selector.

Returns

workbook.DimensionSelector

Supported Script Types

Server scripts

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

Governance

None

Module

N/workbook Module

Sibling Module Members

N/workbook Module Members

Since

2020.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter

Type

Required / Optional

Description

options.dimension

workbook.DataDimension | workbook.Section

required

The dimension of the selector (the dimension to be selected).

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.

            // Add additional code
...
// Create a DataDimension DimensionSelector
var myDimensionSelector = workbook.createDimensionSelector({
    dimension: myDataDimension
});

// Create a Section DimensionSelector
var myDimensionSelector = workbook.createDimensionSelector({
    dimension: mySection
});
...
// Add additional code 

          

Related Topics

N/workbook Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices