workbook.ConditionalFilter

Object Description

A conditional filter object.

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

A conditional filter object is used as a parameter in the workbook.createPivot(options) and workbook.createTableColumn(options) methods.

Supported Script Types

Server scripts

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

Module

N/workbook Module

Methods and Properties

ConditionalFilter 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 myConditionalFilter = workbook.createConditionalFilter({
    filteredNodesSelector: mySelector,
    measure: myMeasure,
    otherAxisSelector: myOtherSelector,
    predicate: myPredicateExpression,
    row: true
});
...
// Add additional code

Syntax

Related Topics