---
title: "External Filter"
framework: javascript
version: "36.1.0"
---

# External Filter

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

> **Warning**
>
> This form of filtering is only compatible with the Client-Side Row Model, see [Row Models](https://www.ag-grid.com/javascript-data-grid/row-models/) for more details.

## Implementing External Filtering

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

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `isExternalFilterPresent` | `IsExternalFilterPresent` |  |  | Grid calls this method to know if an external filter is present. Module: [`ExternalFilterModule`](https://www.ag-grid.com/javascript-data-grid/modules/). |
| `doesExternalFilterPass` | `DoesExternalFilterPass` |  |  | Should return `true` if external filter passes, otherwise `false`. Module: [`ExternalFilterModule`](https://www.ag-grid.com/javascript-data-grid/modules/). |

### isExternalFilterPresent

`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

`doesExternalFilterPass` is called once for each row node in the grid. If you return `false`, the node will be excluded from the final set.

> **Note**
>
> If the external filter changes, you need to call `api.onFilterChanged()` to tell the grid.

## Example

The example below shows an external filter in action.

#### External Filter

```ts
import {
  ClientSideRowModelModule,
  ColDef,
  DateFilterModule,
  ExternalFilterModule,
  GridApi,
  GridOptions,
  IDateFilterParams,
  IRowNode,
  ModuleRegistry,
  NumberFilterModule,
  createGrid,
  enableDevValidations,
} from "ag-grid-community";
import {
  ColumnMenuModule,
  ColumnsToolPanelModule,
  ContextMenuModule,
  SetFilterModule,
} from "ag-grid-enterprise";
import { IOlympicData } from "./interfaces";

// Enable extended validations only for development
if (process.env.NODE_ENV !== "production") {
  enableDevValidations();
}

ModuleRegistry.registerModules([
  ExternalFilterModule,
  ClientSideRowModelModule,
  ColumnsToolPanelModule,
  ColumnMenuModule,
  ContextMenuModule,
  SetFilterModule,
  NumberFilterModule,
  DateFilterModule,
]);

const dateFilterParams: IDateFilterParams = {
  comparator: (filterLocalDateAtMidnight: Date, cellValue: string) => {
    const cellDate = asDate(cellValue);

    if (filterLocalDateAtMidnight.getTime() === cellDate.getTime()) {
      return 0;
    }

    if (cellDate < filterLocalDateAtMidnight) {
      return -1;
    }

    if (cellDate > filterLocalDateAtMidnight) {
      return 1;
    }
    return 0;
  },
};

const columnDefs: ColDef[] = [
  { field: "athlete", minWidth: 180 },
  { field: "age", filter: "agNumberColumnFilter", maxWidth: 80 },
  { field: "country" },
  { field: "year", maxWidth: 90 },
  {
    field: "date",
    filter: "agDateColumnFilter",
    filterParams: dateFilterParams,
  },
  { field: "gold", filter: "agNumberColumnFilter" },
  { field: "silver", filter: "agNumberColumnFilter" },
  { field: "bronze", filter: "agNumberColumnFilter" },
];

let gridApi: GridApi<IOlympicData>;

const gridOptions: GridOptions<IOlympicData> = {
  columnDefs: columnDefs,
  defaultColDef: {
    flex: 1,
    minWidth: 120,
    filter: true,
  },
  isExternalFilterPresent: isExternalFilterPresent,
  doesExternalFilterPass: doesExternalFilterPass,
};

let ageType = "everyone";

function isExternalFilterPresent(): boolean {
  // if ageType is not everyone, then we are filtering
  return ageType !== "everyone";
}

function doesExternalFilterPass(node: IRowNode<IOlympicData>): boolean {
  if (node.data) {
    switch (ageType) {
      case "below25":
        return node.data.age < 25;
      case "between25and50":
        return node.data.age >= 25 && node.data.age <= 50;
      case "above50":
        return node.data.age > 50;
      case "dateAfter2008":
        return asDate(node.data.date) > new Date(2008, 0, 1);
      default:
        return true;
    }
  }
  return true;
}

function asDate(dateAsString: string) {
  const splitFields = dateAsString.split("/");
  return new Date(
    Number.parseInt(splitFields[2]),
    Number.parseInt(splitFields[1]) - 1,
    Number.parseInt(splitFields[0]),
  );
}

function externalFilterChanged(newValue: string) {
  ageType = newValue;
  gridApi!.onFilterChanged();
}

const gridDiv = document.querySelector<HTMLElement>("#myGrid")!;
gridApi = createGrid(gridDiv, gridOptions);

fetch("https://www.ag-grid.com/example-assets/olympic-winners.json")
  .then((response) => response.json())
  .then(function (data) {
    (document.querySelector("#everyone") as HTMLInputElement).checked = true;
    gridApi!.setGridOption("rowData", data);
  });

if (typeof window !== "undefined") {
  // Attach external event handlers to window so they can be called from index.html
  (<any>window).externalFilterChanged = externalFilterChanged;
}
```

[Live example: External Filter](https://www.ag-grid.com/examples/filter-external/external-filter/typescript/)