Framework:Javascript GridAngular GridReact GridVue Grid

Vue Grid: Floating Filter Component

Floating Filter components allow you to add your own floating filter types to AG Grid. Use them:

  • When the provided floating filter for a provided filter does not meet your requirements and you want to replace it with one of your own
  • When you have a custom filter and want to provide a floating filter for your custom filter

This page focuses on writing your own floating filter components. To see general information about floating filters in AG Grid see floating filters.

Simple Floating Filter

Below is a simple example of floating filter component:

const NumberFloatingFilterComponent = {
   template: `
       &gt; <input v-bind:style="{ color: params.color, width: '30px' }" type="number" min="0" 
              v-model="currentValue" v-on:inpuot="onInputBoxChanged()"/>
   `,
   data: function () {
       return {
           currentValue: null
       };
   },
   methods: {
       onInputBoxChanged() {
           if (this.currentValue === '') {
               // clear the filter
               this.params.parentFilterInstance(instance => {
                   instance.onFloatingFilterChanged(null, null);
               });
               return;
           }

           this.params.parentFilterInstance(instance => {
               instance.onFloatingFilterChanged('greaterThan', this.currentValue);
           });
       },

       onParentModelChanged(parentModel) {
           // When the filter is empty we will receive a null value here
           if (!parentModel) {
               this.currentValue = '';
           } else {
               this.currentValue = parentModel.filter;
           }
       }

   }
}

Example: Custom Floating Filter

In the following example you can see how the Gold, Silver, Bronze and Total columns have a custom floating filter NumberFloatingFilter. This filter substitutes the standard floating filter for a input box that the user can change to adjust how many medals of each column to filter by based on a greater than filter.

Since this example is using standard filters, the object that needs to be passed to the method onParentFilterChanged() needs to provide two properties:

  • apply: If true the filter is changed AND applied, otherwise if it is false, the filter is only changed. However, this is ignored unless buttons contains 'apply' (i.e. it is ignored unless the Apply button is being used).
  • model: The model object that represents the new filter state.

If the user removes the content of the input box, the filter is removed.

Note that in this example:

  1. The columns with the floating filter are using the standard Number filter as the base filter
  2. Since the parent filter is the Number filter, the floating filter methods onFloatingFilterChanged(parentModel), and currentParentModel() take and receive model objects that correspond to the model for the Number filter
  3. Since these floating filters are providing a subset of the functionality of their parent filter, which can filter for other conditions which are not 'greaterThan', the user is prevented from seeing the parent filter by adding suppressFilterButton: true in the floatingFilterComponentParams and suppressMenu: true in the colDef
  4. floatingFilterParams for all the medal columns have an additional param that is used to customise the font colour of the floating filter input text box.

Custom Floating Filter Interface

When a Vue component is instantiated the grid will make the grid APIs, a number of utility methods as well as the cell & row values available to you via this.params.

The interface for a custom filter component is as follows:

interface {

   // 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).
   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

When a Vue component is instantiated the grid will make the grid APIs, a number of utility methods as well as the cell & row values available to you via this.params - the interface for what is provided is documented below.

If the user provides params via the colDef.floatingFilterParams attribute, these will be additionally added to the params object, overriding items of the same name if a name clash exists.

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

    // The params object passed to the filter. This is to allow the
    // floating filter access to the configuration of the parent filter.
    // For example, the provided filters use debounceMs from the parent
    // filter params.
    filterParams: IFilterParams;

    // This is a shortcut to invoke getModel on the parent filter.
    // If the parent filter doesn't exist (filters are lazily created as needed)
    // then it returns null rather than calling getModel() on the parent filter.
    currentParentModel(): any;

    // Boolean flag to indicate if the button in the floating filter that
    // opens the parent filter in a popup should be displayed
    suppressFilterButton: boolean;

    // Gets a reference to the parent filter. The result is returned asynchronously
    // via a callback as the parent filter may not exist yet. If it does
    // not exist, it is created and asynchronously returned (AG Grid itself
    // does not create components asynchronously, however if providing a framework
    // provided filter e.g. React, it might be).
    //
    // The floating filter can then call any method it likes on the parent filter.
    // The parent filter will typically provide its own method for the floating
    // filter to call to set the filter. For example, if creating custom filter A,
    // it should have a method your floating A can call to set the state
    // when the user updates via the floating filter.
    parentFilterInstance: (callback: (filterInstance: IFilterComp) => void) => void;

    // Shows the parent filter popup.
    showParentFilter: () => void;

    // The grid API
    api: any;
}

Floating Filter Lifecycle

Floating filters do not contain filter state themselves, but show the state of the actual underlying filter. Floating filters are just another view for the main filter. For this reason, the floating filters lifecycle is bound to the visibility of the column; if you hide a column (either set not visible, or horizontally scroll the column out of view) then the floating filter UI component is destroyed. If the column comes back into view, it is created again. This is different to column filters, where the column filter will exist as long as the column exists, regardless of the column's visibility.

For details on how the floating filter interacts with its associated column filter, see the methods getModelAsString() and onFloatingFilterChanged(change) in the filter component interface.

To see examples of the different ways to implement floating filters please refer to the examples below.

Floating Filter Methods on Provided Filters

When the user interacts with a floating filter, the floating filter must set the state of the main parent filter in order for filter changes to take effect. This is done by the floating filter getting a reference to the parent filter instance and calling a method on it.

If you create your own filter and floating filter, it is up to you which method you expose on the filter for the floating filter to call. This contract is between the filter and the floating filter and doesn't go through the grid.

The simple provided filters (Text, Number, Date) provide methods that the corresponding provided floating filters can call. This information is useful if a) you want to create your own floating filter that is paired with a provided parent filter or b) you are just interested to know how the interaction works to help build your own filters and floating filters.

  • Date, Text and Number Filters: all these filters provide a method onFloatingFilterChanged(type: string, value: string) where type is the type ('lessThan', 'equals', etc.) and the value is the text value to use (the number and date filters will convert the text to the corresponding type).
  • Set Filter: The floating set filter is not editable, so no method is exposed on the parent filter for the floating filter to call.

You could also call setModel() on the filters as an alternative. For example, you could build your own floating filter for the Set Filter that allows picking all European or Asian countries, or you could provide your own Number floating filter that allows selecting ranges (the provided Number floating filter does not allow editing ranges).

Example: Custom Filter And Custom Floating Filter

This example extends the previous example by also providing its own custom filter NumberFilter in the Gold, Silver, Bronze and Total columns.

In this example it is important to note that:

  1. NumberFilter.getModel() returns a number representing the current greater than filter.
  2. NumberFilter.setModel(model) takes an object that can be of any type. If the value passed is numeric then the filter gets applied with a condition of greater than.
  3. NumberFloatingFilter.onParentModelChanged(parentModel) receives the result of NumberFilter.getModel() every time the NumberFilter model changes
  4. NumberFloatingFilter calls params.onFloatingFilterChanged(modelToAccept) every time the user changes the slider value. This will cause an automatic call into NumberFilter.setModel(modelToAccept)
  5. Since NumberFilter.onFloatingFilterChanged(change) is not implemented, every time the user changes the input value the filter gets updated automatically. If this method was implemented it would get called every time the floating filter would change, and would be responsible for performing the filtering.

Example: Custom Filter And Read-Only Floating Filter

If you want to provide a custom filter but don't want to provide an equivalent custom floating filter, you can implement the method filter.getModelAsString() and you will get a read-only floating filter for free.

This example uses the previous custom filter but implementing the getModelAsString() method. Note how there are no custom floating filters and yet each column using NumberFilter (Gold, Silver, Bronze and Total) has a read-only floating filter that gets updated as you change the values from the main filter.

Sliding Floating Filters

The below example shows how to create a custom floating filter re-using the out-of-the-box Number filter with Vue.

Complex example with jQuery

The following example illustrates a complex scenario. All the columns have floating filters. The first 6 columns (Athlete to Sport) have the standard provided floating filters. The last 4 (Gold to Total) have custom filters and custom floating filters that use jQuery sliders.

Note that:

  • Athlete has a debounce of 2 seconds (debounceMs: 2000)
  • Age has no debounce (debounceMs: 0)
  • All the other columns have the standard 500ms debounce