workbook.PathSelector

Object Description

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

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

A path selector object is used as a parameter in the workbook.createConditionalFilter(options), workbook.createLimitingFilter(options), workbook.createMeasureSort(options), workbook.createSortDefinition(options), and workbook.createSortByMeasure(options) methods.

Supported Script Types

Server scripts

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

Module

N/workbook Module

Methods and Properties

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

// View a workbook.PathSelector used in a PivotDefinition
var myWorkbook = workbook.load ({
    id: myWorkbookId
});

var myPathSelector = myWorkbook.pivotDefinitions[0].aggregationFilters[0].filteredNodesSelector.elements;
log.audit({
    title: 'PathSelector.elements = ',
    details: myPathSelector.elements
});
...
// Add additional code

Syntax

Related Topics