External Filter

External filtering allows you to mix your own filtering logic with the grid’s inbuilt filtering, without creating
column-based filter components.

This form of filtering is only compatible with
the Client-Side Row Model, see Row Models for more details.

Implementing External Filtering

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


isExternalFilterPresent is called exactly once every time the grid senses a filter change. It should return True if
external filtering is active or False otherwise. If you return True, 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.

External Filter Example

The example below shows an external filter in action.

View the JavaScript functions used for this example.

These JavaScript functions must be added to the dashAgGridFunctions.js file in the assets folder.
See JavaScript Functions
for more information.

var dagfuncs = (window.dashAgGridFunctions = window.dashAgGridFunctions || {});

dagfuncs.dateAfter2008 = (params) => {
    const splitFields = params.data.date.split('/');

    const date = new Date(
        Number.parseInt(splitFields[1]) - 1,

    return date > new Date(2008, 1, 1)

dagfuncs.dateFilterComparator = (filterLocalDateAtMidnight, cellValue) => {
    const dateAsString = cellValue;

    if (dateAsString == null) {
        return 0;

    // In the example application, dates are stored as dd/mm/yyyy
    // We create a Date object for comparison against the filter date
    const dateParts = dateAsString.split("/");
    const year = Number(dateParts[2]);
    const month = Number(dateParts[1]) - 1;
    const day = Number(dateParts[0]);
    const cellDate = new Date(year, month, day);

    // Now that both parameters are Date objects, we can compare
    if (cellDate < filterLocalDateAtMidnight) {
        return -1;
    } else if (cellDate > filterLocalDateAtMidnight) {
        return 1;
    return 0;