Results:
Loading...
Javascript Data GridJavascriptReact Data GridReactAngular Data GridAngularVue Data GridVue

React Data GridFilter API

You can access and set the models for filters through the grid API, or access individual filter instances directly for more control. This page details how to do both.

Get / Set All Filter Models

It is possible to get the state of all filters using the grid API method getFilterModel(), and to set the state using setFilterModel(). These methods manage the filters states via the getModel() and setModel() methods of the individual filters.

getFilterModel
Function
Gets the current state of all the advanced filters. Used for saving filter state. 
getFilterModel = () => { [key: string]: any; };
setFilterModel
Function
Sets the state of all the advanced filters. Provide it with what you get from getFilterModel() to restore filter state. 
setFilterModel = (model: any) => void;
// Gets filter model via the grid API
const model = gridApi.getFilterModel(); 

// Sets the filter model via the grid API
gridApi.setFilterModel(model);

The filter model represents the state of filters for all columns and has the following structure:

// Sample filter model via getFilterModel()
{
    athlete: {
        filterType: 'text',
        type: 'startsWith',
        filter: 'mich'
    },
    age: {
        filterType: 'number',
        type: 'lessThan',
        filter: 30
    }
}

This is useful if you want to save the global filter state and apply it at a later stage. It is also useful for server-side filtering, where you want to pass the filter state to the server.

Reset All Filters

You can reset all filters by doing the following:

gridApi.setFilterModel(null);

Example: Get / Set All Filter Models

The example below shows getting and setting all the filter models in action.

  • Save Filter Model saves the current filter state, which will then be displayed.
  • Restore Saved Filter Model restores the saved filter state back into the grid.
  • Set Custom Filter Model takes a custom hard-coded filter model and applies it to the grid.
  • Reset Filters will clear all active filters.
  • Destroy Filter destroys the filter for the Athlete column by calling gridApi.destroyFilter('athlete'). This removes any active filter from that column, and will cause the filter to be created with new initialisation values the next time it is interacted with.

(Note: the example uses the Enterprise-only Set Filter).

Accessing Individual Filter Component Instances

It is also possible to access the filter components directly if you want to interact with a specific filter. This also works for your own custom filters, where you can get a reference to the underlying filtering instance (i.e. what was created when AG Grid called new on your filter). Calling api.getFilterInstance(colKey) will return a reference to the filter instance for the column with key colKey.

getFilterInstance
Function
Returns the filter component instance for a column. key can be a string field name or a ColDef object (matches on object reference, useful if field names are not unique). If your filter is created asynchronously, getFilterInstance will return null so you will need to use the callback to access the filter instance instead. 
getFilterInstance = (
    key: string | Column,
    callback?: (filter: TFilter | null) => void
) => TFilter | null | undefined;
// Get a reference to the 'name' filter instance
const filterInstance = gridApi.getFilterInstance('name');

All of the methods of the filter are available on the instance. If using a custom filter, any other methods you have added will also be present, allowing bespoke behaviour to be added to your filter. Both provided and custom filters implement IFilter and have the following common methods:

isFilterActive
Function
Returns true if the filter is currently active, otherwise false. If active then 1) the grid will show the filter icon in the column header and 2) the filter will be included in the filtering of the data. 
isFilterActive = () => boolean;
getModel
Function
Returns a model representing the current state of the filter, or null if the filter is not active. The grid calls getModel() on all active filters when gridApi.getFilterModel() is called. 
getModel = () => any;
setModel
Function
Sets the state of the filter using the supplied model. Providing null as the model will de-activate the filter. 
setModel = (model: any) => void | AgPromise<void>;

For filters that are created asynchronously, including React 16+ components, getFilterInstance will return null if the filter has not already been created. If your app uses asynchronous components, use the optional callback function which will be invoked with the filter instance when it is available.

// Get a reference to an asynchronously created filter instance
gridApi.getFilterInstance('name', filterInstance => {
     // ... use filterInstance here
 });

Re-running Grid Filtering

After filters have been changed via their API, you must ensure the method gridApi.onFilterChanged() is called to tell the grid to filter the rows again. If gridApi.onFilterChanged() is not called, the grid will still show the data relevant to the filters before they were updated through the API.

// Get a reference to the filter instance
const filterInstance = gridApi.getFilterInstance('name'); 

// Set the filter model
filterInstance.setModel({
    filterType: 'text',
    type: 'startsWith',
    filter: 'abc',
 });

// Tell grid to run filter operation again
gridApi.onFilterChanged();

Reset Individual Filters

You can reset a filter to its original state by getting the filter instance and setting the model to null.

// Get a reference to the filter instance
const filterInstance = gridApi.getFilterInstance('name'); 

// Set the model to null
filterInstance.setModel(null);

// Tell grid to run filter operation again
gridApi.onFilterChanged();

Example: Accessing Individual Filters

The example below shows how you can interact with an individual filter instance, using the Set Filter as an example.

  • Get Mini Filter Text will print the text from the Set Filter's Mini Filter to the console.
  • Save Mini Filter Text will save the Mini Filter text.
  • Restore Mini Filter Text will restore the Mini Filter text from the saved state.
  • Reset Filter will reset the filter.

(Note: the example uses the Enterprise-only Set Filter).

Read-only Filter UI

Sometimes it maybe useful to strictly control the filters used by the grid via API, whilst still exposing filter settings in-use to users. The readOnly filter parameter changes the behaviour of all provided column filters so their UI is read-only. In this mode, API filter changes are still honoured and reflected in the UI:

const columnDefs = [
    {
        field: 'age',
        filter: true,
        filterParams: {
            readOnly: true
        }
    }
];

<AgGridReact columnDefs={columnDefs}></AgGridReact>

The following example demonstrates all of the Provided Filters with readOnly: true enabled:

  • Simple Filters have a read-only display with no buttons; if there is no 2nd condition set then the join operator and 2nd condition are hidden:

  • Set Filter allows Mini Filter searching of values, but value inclusion/exclusion cannot be toggled; buttons are also hidden, and pressing enter in the Mini Filter input has no effect:

    • country, gold, silver and bronze columns demonstrate Set Filter.

  • Multi Filter has no direct behaviour change, sub-filters need to be individually made read-only. readOnly: true is needed to affect any associated Floating Filters.

  • Floating Filters are enabled and inherit readOnly: true from their parent, disabling any UI input.
  • Buttons above the grid provide API interactions to configure the filters.

Filter Events

Filtering causes the following events to be emitted:

filterOpened
FilterOpenedEvent
Filter has been opened. 
onFilterOpened = (
    event: FilterOpenedEvent<TData>
) => void;

interface FilterOpenedEvent<TData = any, TContext = any> {
  // Column / OriginalColumnGroup that contains the filter 
  column: Column | ProvidedColumnGroup;
  // Source of the open request 
  source: FilterRequestSource;
  // Parent element of the filter 
  eGui: HTMLElement;
  // The grid api. 
  api: GridApi<TData>;
  // The column api. 
  columnApi: ColumnApi;
  // Application context as set on `gridOptions.context`. 
  context: TContext;
  // Event identifier 
  type: string;
}

type FilterRequestSource = 
      'COLUMN_MENU' 
    | 'TOOLBAR' 
    | 'NO_UI'
filterChanged
FilterChangedEvent
Filter has been modified and applied. 
onFilterChanged = (
    event: FilterChangedEvent<TData>
) => void;

interface FilterChangedEvent<TData = any, TContext = any> {
  // True if the filter was changed as a result of data changing 
  afterDataChange?: boolean;
  // True if filter was changed via floating filter 
  afterFloatingFilter?: boolean;
  // Columns affected by the filter change. Array contents depend on the source of the event.
  //
  // - Expect 1 element for UI-driven column filter changes.
  // - Expect 0-N elements (all affected columns) for calls to `gridOptions.api.setFilterModel()`.
  // - Expect 0-N elements (removed columns) for calls to `gridOptions.api.setColumnDefs()`.
  // - Expect 0 elements for quick-filters and calls to `gridOptions.api.onFilterChanged()`.
  columns: Column[];
  // The grid api. 
  api: GridApi<TData>;
  // The column api. 
  columnApi: ColumnApi;
  // Application context as set on `gridOptions.context`. 
  context: TContext;
  // Event identifier 
  type: string;
}
filterModified
FilterModifiedEvent
Filter was modified but not applied. Used when filters have 'Apply' buttons. 
onFilterModified = (
    event: FilterModifiedEvent<TData>
) => void;

interface FilterModifiedEvent<TData = any, TContext = any> {
  filterInstance: IFilterComp;
  column: Column;
  // The grid api. 
  api: GridApi<TData>;
  // The column api. 
  columnApi: ColumnApi;
  // Application context as set on `gridOptions.context`. 
  context: TContext;
  // Event identifier 
  type: string;
}

Next Up

Continue to the next section to learn about Floating Filters.