workbook.ConditionalFilter

Note:

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

Object Description

A conditional filter.

Use conditional filters when you create pivots using workbook.createPivot(options).

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

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.

            // Add additional code
...
var myConditionalFilter = workbook.createConditionalFilter({
    filteredNodesSelector: mySelector,
    measure: myMeasure,
    otherAxisSelector: myOtherSelector,
    predicate: myPredicateExpression,
    row: true
});
...
// Add additional code

Syntax

Related Topics