TableColumnFilter Object Members in SuiteScript

The TableColumnFilter object is a vital component in SuiteScript, specifically designed for creating filters on table columns within workbooks. This object allows developers to apply various filtering operations, enhancing data manipulation capabilities in custom reports and data presentations.

What is the TableColumnFilter Object?

A TableColumnFilter object is instantiated using workbook.createTableColumnFilter(options). It serves as a parameter for the method workbook.createConditionalFormatRule(options), enabling customized conditional formatting based on specific criteria.

TableColumnFilter Object Members

The TableColumnFilter object comprises two primary members:

Property Descriptions

• operator: This property determines the filter's operator. It is crucial for defining how the filter behaves (e.g., equals, not equals).
• values: This property consists of an array that can hold multiple types of values (null, object, boolean, number, string, date) that the filter will act upon.

Supported Script Types

The TableColumnFilter is designed for use in server scripts only. For more insights, refer to the SuiteScript 2.x Script Types.

Error Handling

Developers should also be aware of potential error codes associated with this object:

• INVALID_OPERATOR: Raised when an unsupported operator is used.
• WRONG_PARAMETER_TYPE: Raised if the provided value for the operator is not a string.

By utilizing the TableColumnFilter, developers can finely tweak their table display and enhance user interfaces with dynamic filters that respond instantly to data changes. This makes data analysis more intuitive and efficient.

Key Takeaways

• The TableColumnFilter allows for dynamic filtering in workbook tables.
• It includes essential properties like operator and values.
• Only applicable in server scripts, supporting various data types for flexible usage.