Expand All

  Getting Started

  Reference

  Features

  Row Models

  Themes

  Components

  Examples

  Third Party

Misc

Github stars make projects look great. Please help, donate a star, it's free.
Read about ag-Grid's Partnership with webpack.
Get informed on releases and other ag-Grid news only - never spam.
Follow on Twitter

External Filter

It is common for you to want to have widgets on the top of your grid that influence the grids filtering. External filtering allows you to mix your own 'outside of the grid' filtering with the grids filtering.

The example below shows external filters in action. There are two methods on gridOptions you need to implement: isExternalFilterPresent() and doesExternalFilterPass(node).

  • isExternalFilterPresent is called exactly once every time the grid senses a filter change. It should return true if external filtering is active, otherwise false. If you return true, then doesExternalFilterPass() will be called while filtering, otherwise doesExternalFilterPass() will not be called.
  • doesExternalFilterPass is called once for each row node in the grid. If you return false, the node will be excluded from the final set.

If the external filter changes, then you need to call api.onFilterChanged() to tell the grid

The example below shows the external filters in action.