Modules

filter

 

Objects/Functions

module (N/workbook)

SuiteScript 2.0

workbook.LimitingFilter

// Please search https://system.netsuite.com/app/help/helpcenter.nl?search=workbook.LimitingFilter for more information.

N/workbook Module
workbook.LimitingFilter
Object Description: A limiting filter. A limiting factor can be used when you create a chart definition or a pivot definition. You can create a limiting filter using workbook.createLimitingFilter(options).
Supported Script Types: Server scripts For more information, see SuiteScript 2.0 Script Types.
Module: N/workbook Module
Methods and Properties: LimitingFilter Object Members
Since: 2020.2
Search NetSuite - https://system.netsuite.com/app/help/helpcenter.nl?search=workbook.LimitingFilter

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: workbook.createAllSubNodesSelector()
});

// View a workbook.LimitingFilter used in a PivotDefinition
var myWorkbook = workbook.load ({
id: myWorkbookId
});

// Note that some LimitingFilter properties may be empty/null based on the loaded workbook
var myLimitingFilter = myWorkbook.pivotDefinitions[0].aggregationFilters[0];
log.audit({
title: 'LimitingFilter row = ',
details: myLimitingFilter.row
});
log.audit({
title: 'LimitingFilter filteredNodesSelector = ',
details: myLimitingFilter.filteredNodesSelector
});
log.audit({
title: 'Limiting Filter limit = ',
details: myLimitingFilter.limit
});
log.audit({
title: 'LimitingFilter sortBys = ',
details: myLimitingFilter.sortBys
});
//...
// Add additional code

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