LimitingFilter.limit

Note:

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

Property Description

The limit number for the limiting filter.

Type

number

Module

N/workbook Module

Parent Object

workbook.LimitingFilter

Sibling Object Members

LimitingFilter Object Members

Since

2020.2

Errors

Error Code

Thrown If

WRONG_PARAMETER_TYPE

The value for this property is not a number.

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

var theLimit = myLimitingFilter.limit;
...
// Add additional code 

          

Related Topics

workbook.LimitingFilter
N/workbook Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices