display.grid.applyFilter()

Content Freeze

As of July 25th, 2023, there is a content freeze on this page.

The applyFilter() method replace grid records with the records that satisfy the provided testing function.

Parameter

Callback function that receives the following arguments:
1. Record object with properties for each field in the grid
2. Index - the zero-based index of the current grid record being processed
3. Records array - array representing all of the grid records

The function must return true when the test condition is met.

Example

// Remove records where the "remove" Boolean Indicator was set to true
// In a Rich Display application, this could be triggered by the user clicking a Remove button with a bound response property
display.grid.applyFilter(entry => !entry.remove);