LimitingFilter Object Members for SuiteScript Development

The LimitingFilter object is pivotal in SuiteScript development, particularly in scenarios requiring data manipulation through workbook creation. This object is essential when you want to filter results in pivot tables, allowing for finer control of how data is aggregated and displayed.

What is the LimitingFilter Object?

The LimitingFilter object is utilized in the workbook module to constrain the results generated by pivot tables. It is created using the workbook.createLimitingFilter(options) function and is passed as a parameter to the workbook.createPivot(options) method. This allows developers to filter and limit data effectively while creating custom reports.

Members of the LimitingFilter Object

The LimitingFilter object contains several members, each serving a unique purpose in the filtering process. Below is a detailed overview of its members:

Example Syntax

The following code snippet demonstrates how to create a LimitingFilter object:

1// Creating a limiting filter object
2var myLimitingFilter = workbook.createLimitingFilter({
3    row: true,
4    sortBys: [myMeasureSort],
5    limit: 12,
6    filteredNodesSelector: myDimensionSelector
7});

In this example, the limiting filter is set to allow a maximum of 12 records, with results sorted based on specified measurement criteria.

Error Handling

When working with LimitingFilter, be aware of potential error codes that may occur:

• WRONG_PARAMETER_TYPE: This error is thrown if an invalid type is passed for the filteredNodesSelector property. Ensure it matches either workbook.PathSelector or workbook.DimensionSelector.

By incorporating LimitingFilter objects, SuiteScript developers can significantly enhance the capabilities of their data presentations, making it easier to work with large datasets by focusing on relevant information.

Key Considerations

• The workbook.createLimitingFilter function requires familiarity with defining and limiting data selections.
• Proper parameter types must be adhered to, ensuring the script runs without error.

This approach not only optimizes performance but also improves the user experience when interacting with data reports.