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 Copy Link
The example below shows external filters in action. There are two methods on gridOptions you need to implement: isExternalFilterPresent and doesExternalFilterPass.
Grid calls this method to know if an external filter is present. |
Should return true if external filter passes, otherwise false. |
isExternalFilterPresent Copy Link
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 Copy Link
doesExternalFilterPass is called once for each row node in the grid. If you return false, the node will be excluded from the final set.
If the external filter changes, you need to call api.onFilterChanged() to tell the grid.
Example Copy Link
The example below shows an external filter in action.
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;
}
.test-container {
height: 100%;
display: flex;
flex-direction: column;
}
.test-header {
font-family: Verdana, Geneva, Tahoma, sans-serif;
font-size: 13px;
margin-bottom: 10px;
display: flex;
justify-content: space-around;
border: 1px solid grey;
padding: 10px;
border-radius: 5px;
}
<div class="test-container">
<div class="test-header">
<label>
<input type="radio" name="filter" id="everyone" onchange="externalFilterChanged('everyone')" />
Everyone
</label>
<label>
<input type="radio" name="filter" id="below25" onchange="externalFilterChanged('below25')" />
Below 25
</label>
<label>
<input type="radio" name="filter" id="between25and50" onchange="externalFilterChanged('between25and50')" />
Between 25 and 50
</label>
<label>
<input type="radio" name="filter" id="above50" onchange="externalFilterChanged('above50')" />
Above 50
</label>
<label>
<input type="radio" name="filter" id="dateAfter2008" onchange="externalFilterChanged('dateAfter2008')" />
After 01/01/2008
</label>
</div>
<div id="myGrid" style="height: 100%"></div>
</div>
export interface IOlympicData {
athlete: string,
age: number,
country: string,
year: number,
date: string,
sport: string,
gold: number,
silver: number,
bronze: number,
total: number
}