ConditionalFilter.predicate

Note:

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

Property Description	The predicate expression for the conditional filter, which indicates whether the condition is met.
Type	workbook.Expression
Module	N/workbook Module
Parent Object	workbook.ConditionalFilter
Sibling Object Members	ConditionalFilter Object Members
Since	2020.2

Errors

Error Code	Thrown If
WRONG_PARAMETER_TYPE	The value specified for this property is not a workbook.Expression.

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
});

var thePredicate = myConditionalFilter.predicate;
...
// Add additional code 

          

Related Topics

workbook.ConditionalFilter

N/workbook Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices