workbook.createLimitingFilter(options)
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 to limit the data shown on a pivot. |
Returns |
|
Supported Script Types |
Server scripts For more information, see SuiteScript 2.x Script Types. |
Governance |
None |
Module |
|
Sibling Module Members |
|
Since |
2020.2 |
Parameters
The options
parameter is a JavaScript object.
Parameter |
Type |
Required / Optional |
Description |
---|---|---|---|
|
required |
The selector for the limiting filter. |
|
|
number |
required |
The limit for the limiting filter. |
|
boolean |
required |
Indicator for a row axis filter. If set to false, the filter is a on a column axis. |
|
required |
The sort order for the limiting filter. |
Syntax
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
...
// 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