Framework:Javascript Data GridAngular Data GridReact Data GridVue Data Grid

Angular Data Grid: Filter Component

Filter components allow you to add your own filter types to AG Grid. Use them when the provided filters do not meet your requirements.

Simple Filter

Below is a simple example of filter component class:

import {AgFilterComponent} from "@ag-grid-community/angular";
import {IDoesFilterPassParams, IFilterParams} from "@ag-grid-community/core";

@Component({
   selector: 'year-component',
   template: `
     <div style="display: inline-block; width: 400px;">
          <div style="padding: 10px; background-color: #d3d3d3; text-align: center;">This is a very wide filter</div>
          <label style="margin: 10px; padding: 50px; display: inline-block; background-color: #999999">
              <input type="radio" name="year" [(ngModel)]="year" (ngModelChange)="updateFilter()" [value]="'All'"/> All
          </label>
          <label style="margin: 10px; padding: 50px; display: inline-block; background-color: #999999">
              <input type="radio" name="year" [(ngModel)]="year" (ngModelChange)="updateFilter()" [value]="'2010'"/> Since 2010
          </label>
     </div>
   `
})
export class YearFilter implements AgFilterComponent {
   params: IFilterParams;
   year: string = 'All';

   agInit(params: IFilterParams): void {
       this.params = params;
   }

   isFilterActive(): boolean {
       return this.year === '2010'
   }

   doesFilterPass(params: IDoesFilterPassParams): boolean {
       return params.data.year >= 2010;
   }

   getModel() {
   }

   setModel(model: any) {
   }

   updateFilter() {
       this.params.filterChangedCallback();
   }
}

Custom Filter Example

The example below shows two custom filters. The first is on the Athlete column and demonstrates a filter with "fuzzy" matching and the second is on the Year column and uses the YearFilter above.

Custom Filter Interface

The interface for a custom filter component is as follows:

interface AgFilterComponent {
   // params for filter operations (see below for more details)
   agInit(params: IFilterParams): void;

   // Return true if the filter is active. 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;

   // The grid will ask each active filter, in turn, whether each row in the grid passes. If any
   // filter fails, then the row will be excluded from the final set. A params object is supplied
   // containing attributes of node (the rowNode the grid creates that wraps the data) and data (the data
   // object that you provided to the grid for that row).
   doesFilterPass(params: IDoesFilterPassParams): boolean;

   // Gets the filter state. If filter is not active, then should return null/undefined.
   // The grid calls getModel() on all active filters when gridApi.getFilterModel() is called.
   getModel(): any;

   // Restores the filter state. Called by the grid after gridApi.setFilterModel(model) is called.
   // The grid will pass undefined/null to clear the filter.
   setModel(model: any): void;


   // Optional methods

   // Gets called when new rows are inserted into the grid. If the filter needs to change its
   // state after rows are loaded, it can do it here. For example the set filters uses this
   // to update the list of available values to select from (e.g. 'Ireland', 'UK' etc for
   // Country filter). To get the list of available values from within this method from the
   // Client Side Row Model, use gridApi.forEachLeafNode(callback)
   onNewRowsLoaded?(): void;

   // Gets called when the column is destroyed. If your custom filter needs to do
   // any resource cleaning up, do it here. A filter is NOT destroyed when it is
   // made 'not visible', as the GUI is kept to be shown again if the user selects
   // that filter again. The filter is destroyed when the column it is associated with is
   // destroyed, either when new columns are set into the grid, or the grid itself is destroyed.
   destroy?(): void;

   // If floating filters are turned on for the grid, but you have no floating filter
   // configured for this column, then the grid will check for this method. If this
   // method exists, then the grid will provide a read-only floating filter for you
   // and display the results of this method. For example, if your filter is a simple
   // filter with one string input value, you could just return the simple string
   // value here.
   getModelAsString?(model: any): string;
}

Custom Filter Parameters

The agInit(params) method takes a params object with the items listed below. If the user provides params via the colDef.filterParams attribute, these will be additionally added to the params object, overriding items of the same name if a name clash exists.

interface IFilterParams {
    // The column this filter is for
    column: Column;

    // The column definition for the column
    colDef: ColDef;

    // The row model, helpful for looking up data values if needed.
    // If the filter needs to know which rows are a) in the table,
    // b) currently visible (i.e. not already filtered), c) which groups,
    // d) what order - all of this can be read from the rowModel.
    rowModel: IRowModel;

    // A function callback to be called when the filter changes. The
    // grid will then respond by filtering the grid data. The callback
    // takes one optional parameter which, if included, will get merged
    // to the FilterChangedEvent object (useful for passing additional
    // information to anyone listening to this event, however such extra
    // attributes are not used by the grid).
    filterChangedCallback: (additionalEventAttributes?: any) => void;

    // A function callback, to be optionally called, when the filter UI changes.
    // The grid will respond with emitting a FilterModifiedEvent. Apart from
    // emitting the event, the grid takes no further action.
    filterModifiedCallback: () => void;

    // A function callback for the filter to get cell values from the
    // row data. Call with a node to be given the value for that filter's
    // column for that node. The callback takes care of selecting the
    // right column definition and deciding whether to use valueGetter
    // or field etc. This is useful in, for example, creating an Excel
    // style filter, where the filter needs to lookup available values
    // to allow the user to select from.
    valueGetter: (rowNode: RowNode) => any;

    // A function callback, call with a node to be told whether the node
    // passes all filters except the current filter. This is useful if you
    // want to only present to the user values that this filter can filter
    // given the status of the other filters. The set filter uses this to
    // remove from the list, items that are no longer available due to the
    // state of other filters (like Excel type filtering).
    doesRowPassOtherFilter: (rowNode: RowNode) => boolean;

    // The context for this grid. See section on Context
    context: any;

    // The grid API
    api: any;

    // Only if using AngularJS (ie Angular v1), if angularCompileFilters
    // is set to true, then a new child scope is created for each column
    // filter and provided here.
    $scope: any;
}

IDoesFilterPassParams

The method doesFilterPass(params) takes the following as a parameter:

interface IDoesFilterPassParams {
    // The row node in question
    node: RowNode;

    // The data part of the row node in question
    data: any;
}

Associating Floating Filter

If you create your own filter you have two options to get floating filters working for that filter:

  1. You can create your own floating filter.
  2. You can implement the getModelAsString() method in your custom filter. If you implement this method and don't provide a custom floating filter, AG Grid will automatically provide a read-only version of a floating filter.

If you don't provide either of these two options for your custom filter, the display area for the floating filter will be empty.

Custom Filters Containing a Popup Element

Sometimes you will need to create custom components for your filters that also contain popup elements. This is the case for Date Filter as it pops up a Date Picker. If the library you use anchors the popup element outside of the parent filter, then when you click on it the grid will think you clicked outside of the filter and hence close the column menu.

There are two ways you can get fix this problem:

  • Add a mouse click listener to your floating element and set it to preventDefault(). This way, the click event will not bubble up to the grid. This is the best solution, but you can only do this if you are writing the component yourself.
  • Add the ag-custom-component-popup CSS class to your floating element. An example of this usage can be found here: Custom Date Component

Accessing the Angular Component Instance

AG Grid allows you to get a reference to the filter instances via the api.getFilterInstance(colKey) method. If your component is a Angular component, this will give you a reference to AG Grid's component which wraps your Angular component, just like Russian Dolls. To get to the wrapped Angular instance of your component, use the getFrameworkComponentInstance() method as follows:

// let's assume an Angular component as follows
@Component({
    selector: 'filter-cell',
    template: `
        Filter: <input style="height: 10px" #input (ngModelChange)="onChange($event)" [ngModel]="text">
    `
})
class PartialMatchFilterComponent implements AgFilterComponent {
    ... // standard filter methods hidden

    // put a custom method on the filter
    myMethod() {
        // does something
    }
}

// later in your app, if you want to execute myMethod()...
laterOnInYourApplicationSomewhere() {
    // get reference to the AG Grid Filter component
    const agGridFilter = api.getFilterInstance('name'); // assume filter on name column

    // get Angular instance from the AG Grid instance
    const angularFilterInstance = agGridFilter.getFrameworkComponentInstance();

    // now we're sucking diesel!!!
    angularFilterInstance.myMethod();
}

The example below illustrates how a custom filter component can be accessed and methods on it invoked: