workbook.LimitingFilter

Object Description

A limiting filter object which can be used when you create a pivot.

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

A limiting filter object is used as a parameter in the workbook.createPivot(options) method.

Supported Script Types

Server scripts

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

Module

N/workbook Module

Methods and Properties

LimitingFilter 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 myLimitingFilter = workbook.createLimitingFilter({
    row: true,
    sortBys: [myMeasureSort],
    limit: 12,
    filteredNodesSelector: myDimensionSelector
});
...
// Add additional code

Syntax

Related Topics