workbook.createPathSelector(options)

Note:

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

Method Description	Creates a path selector.
Returns	workbook.PathSelector
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.elements	workbook.DimensionSelector[]	required	The elements in the path selector.

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 an AllSubNodesSelector PathSelector
var myPathSelector = workbook.createPathSelector({
    elements: [workbook.createAllSubNodesSelector()]
});
// Create a DimensionSelector PathSelector
var myPathSelector = workbook.createPathSelector({
    elements: [myDimensionSelector]
});
...
// Add additional code 

          

Related Topics

N/workbook Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices