Modules

filter

 

Objects/Functions

module (N/workbook)

SuiteScript 2.0

workbook.createLimitingFilter(options)

{workbook}.createLimitingFilter({filteredNodesSelector: {workbook.AllSubNodesSelector |workbook.DimensionSelector | workbook.PathSelector*},limit: {number*},row: {boolean*},sortBys: {Array*}})

N/workbook Module
workbook.createLimitingFilter()
Method Description: Creates a limiting filter, which includes a selector of what to filter, a row axis, a limit, and a sorting order. Limiting filters can be used in pivot definitions and chart definitions to limit the data shown on a pivot or chart.
Returns: workbook.LimitingFilter
Supported Script Types: Server scripts For more information, see SuiteScript 2.0 Script Types.
Governance: None
Module: N/workbook Module
Sibling Module Members: N/workbook Module Members
Since: 2020.2
Search NetSuite - https://system.netsuite.com/app/help/helpcenter.nl?search=workbook.createLimitingFilter(options)

Example:

// Code Example 1
// Add additional code
//...
// Create a DimensionSelector LimitingFilter sorting by MeasureSort
var myLimitingFilter = workbook.createLimitingFilter({
row: true,
sortBys: [myMeasureSort],
limit: 12,
filteredNodesSelector: myDimensionSelector
});

// Create a PathSelector LimitingFilter sorting by DimensionSort
var myLimitingFilter = workbook.createLimitingFilter({
row: true,
sortBys: [myDimensionSort],
limit: 12,
filteredNodesSelector: myPathSelector
});

// Create a AllSubNodesSelector Limiting Filter
var myLimitingFilter = workbook.createLimitingFilter({
row: true,
sortBys: [myDimensionSort],
limit: 12,
filteredNodesSelector: mySelector
});
//...
// Add additional code

//SOURCE: https://system.netsuite.com/app/help/helpcenter.nl?fid=section_159051462385.html