ConditionalFilter Object Members in SuiteScript 2.1

The ConditionalFilter object is integral for managing dynamic filtering in reports and data presentations within SuiteScript 2.1. It allows developers to programmatically define filtering criteria on reports and tables, enhancing the reports' interactivity and usability.

What Is a ConditionalFilter?

A ConditionalFilter object is utilized to set various conditions under which data will be filtered. This is particularly useful when creating pivot tables or other complex data presentations in applications. The conditional filter serves as a parameter in methods like workbook.createPivot(options) and workbook.createTableColumn(options), enabling fine-grained control over the displayed data.

Members of the ConditionalFilter Object

The following table lists the members available for a workbook.ConditionalFilter object, including their return types and supported script types:

Syntax Example

Here is a syntax example demonstrating how to create a ConditionalFilter:

1// Add additional code
2...
3var myConditionalFilter = workbook.createConditionalFilter({
4    filteredNodesSelector: mySelector,
5    measure: myMeasure,
6    otherAxisSelector: myOtherSelector,
7    predicate: myPredicateExpression,
8    row: true
9});
10...
11// Add additional code

Who Should Use ConditionalFilter?

This object will benefit developers working within the SuiteScript environment, particularly those looking to enhance reporting capabilities or implement advanced data visualization techniques.

Key Points

• The ConditionalFilter object is essential for dynamic data filtering in SuiteScript.
• Members of the ConditionalFilter allow comprehensive control over filtering criteria.
• This object integrates seamlessly with reports by utilizing methods like workbook.createPivot() and workbook.createTableColumn().