DevExtreme v24.1 is now available.

Explore our newest features/capabilities and share your thoughts with us.

Your search did not match any results.

Filtering API

The DataGrid includes the following API you can use to filter data.

Backend API
import React, { useCallback, useRef, useState } from 'react'; import DataGrid, { Column, DataGridRef } from 'devextreme-react/data-grid'; import SelectBox from 'devextreme-react/select-box'; import 'devextreme/data/odata/store'; const dataSourceOptions = { store: { type: 'odata' as const, version: 2, url: 'https://js.devexpress.com/Demos/DevAV/odata/Tasks', key: 'Task_ID', }, expand: 'ResponsibleEmployee', select: [ 'Task_ID', 'Task_Subject', 'Task_Start_Date', 'Task_Status', 'ResponsibleEmployee/Employee_Full_Name', ], }; const statuses = ['All', 'Not Started', 'In Progress', 'Need Assistance', 'Deferred', 'Completed']; const statusLabel = { 'aria-label': 'Status' }; const App = () => { const [filterStatus, setFilterStatus] = useState(statuses[0]); const dataGridRef = useRef<DataGridRef>(null); const onValueChanged = useCallback(({ value }) => { const dataGrid = dataGridRef.current.instance(); if (value === 'All') { dataGrid.clearFilter(); } else { dataGrid.filter(['Task_Status', '=', value]); } setFilterStatus(value); }, []); return ( <div> <div className="left-side"> <div className="logo"> <img src="../../../../images/logo-devav.png" alt="DEVAV"/> &nbsp; <img src="../../../../images/logo-tasks.png" alt="Tasks"/> </div> </div> <div className="right-side"> <SelectBox items={statuses} inputAttr={statusLabel} value={filterStatus} onValueChanged={onValueChanged} /> </div> <DataGrid id="gridContainer" ref={dataGridRef} dataSource={dataSourceOptions} columnAutoWidth={true} showBorders={true} > <Column dataField="Task_ID" width={80} /> <Column dataField="Task_Start_Date" caption="Start Date" dataType="date" /> <Column allowSorting={false} dataField="ResponsibleEmployee.Employee_Full_Name" cssClass="employee" caption="Assigned To" /> <Column dataField="Task_Subject" caption="Subject" width={350} /> <Column dataField="Task_Status" caption="Status" /> </DataGrid> </div> ); }; export default App;
import React, { useCallback, useRef, useState } from 'react'; import DataGrid, { Column } from 'devextreme-react/data-grid'; import SelectBox from 'devextreme-react/select-box'; import 'devextreme/data/odata/store'; const dataSourceOptions = { store: { type: 'odata', version: 2, url: 'https://js.devexpress.com/Demos/DevAV/odata/Tasks', key: 'Task_ID', }, expand: 'ResponsibleEmployee', select: [ 'Task_ID', 'Task_Subject', 'Task_Start_Date', 'Task_Status', 'ResponsibleEmployee/Employee_Full_Name', ], }; const statuses = ['All', 'Not Started', 'In Progress', 'Need Assistance', 'Deferred', 'Completed']; const statusLabel = { 'aria-label': 'Status' }; const App = () => { const [filterStatus, setFilterStatus] = useState(statuses[0]); const dataGridRef = useRef(null); const onValueChanged = useCallback(({ value }) => { const dataGrid = dataGridRef.current.instance(); if (value === 'All') { dataGrid.clearFilter(); } else { dataGrid.filter(['Task_Status', '=', value]); } setFilterStatus(value); }, []); return ( <div> <div className="left-side"> <div className="logo"> <img src="../../../../images/logo-devav.png" alt="DEVAV" /> &nbsp; <img src="../../../../images/logo-tasks.png" alt="Tasks" /> </div> </div> <div className="right-side"> <SelectBox items={statuses} inputAttr={statusLabel} value={filterStatus} onValueChanged={onValueChanged} /> </div> <DataGrid id="gridContainer" ref={dataGridRef} dataSource={dataSourceOptions} columnAutoWidth={true} showBorders={true} > <Column dataField="Task_ID" width={80} /> <Column dataField="Task_Start_Date" caption="Start Date" dataType="date" /> <Column allowSorting={false} dataField="ResponsibleEmployee.Employee_Full_Name" cssClass="employee" caption="Assigned To" /> <Column dataField="Task_Subject" caption="Subject" width={350} /> <Column dataField="Task_Status" caption="Status" /> </DataGrid> </div> ); }; export default App;
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.tsx'; ReactDOM.render( <App />, document.getElementById('app'), );
window.exports = window.exports || {}; window.config = { transpiler: 'ts', typescriptOptions: { module: 'system', emitDecoratorMetadata: true, experimentalDecorators: true, jsx: 'react', }, meta: { 'react': { 'esModule': true, }, 'typescript': { 'exports': 'ts', }, 'devextreme/time_zone_utils.js': { 'esModule': true, }, 'devextreme/localization.js': { 'esModule': true, }, 'devextreme/viz/palette.js': { 'esModule': true, }, }, paths: { 'npm:': 'https://unpkg.com/', }, defaultExtension: 'js', map: { 'ts': 'npm:plugin-typescript@4.2.4/lib/plugin.js', 'typescript': 'npm:typescript@4.2.4/lib/typescript.js', 'react': 'npm:react@17.0.2/umd/react.development.js', 'react-dom': 'npm:react-dom@17.0.2/umd/react-dom.development.js', 'prop-types': 'npm:prop-types@15.8.1/prop-types.js', 'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js', 'luxon': 'npm:luxon@1.28.1/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign@1.1.0', 'devextreme': 'npm:devextreme@24.1.3/cjs', 'devextreme-react': 'npm:devextreme-react@24.1.3/cjs', 'jszip': 'npm:jszip@3.10.1/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.7.1/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.2.8/dist/dx-diagram.js', 'devexpress-gantt': 'npm:devexpress-gantt@4.1.56/dist/dx-gantt.js', '@devextreme/runtime': 'npm:@devextreme/runtime@3.0.13', 'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js', 'inferno-compat': 'npm:inferno-compat/dist/inferno-compat.min.js', 'inferno-create-element': 'npm:inferno-create-element@7.4.11/dist/inferno-create-element.min.js', 'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js', 'inferno-hydrate': 'npm:inferno-hydrate@7.4.11/dist/inferno-hydrate.min.js', 'inferno-clone-vnode': 'npm:inferno-clone-vnode/dist/inferno-clone-vnode.min.js', 'inferno-create-class': 'npm:inferno-create-class/dist/inferno-create-class.min.js', 'inferno-extras': 'npm:inferno-extras/dist/inferno-extras.min.js', 'devextreme-cldr-data': 'npm:devextreme-cldr-data@1.0.3', // SystemJS plugins 'plugin-babel': 'npm:systemjs-plugin-babel@0.0.25/plugin-babel.js', 'systemjs-babel-build': 'npm:systemjs-plugin-babel@0.0.25/systemjs-babel-browser.js', // Prettier 'prettier/standalone': 'npm:prettier@2.8.8/standalone.js', 'prettier/parser-html': 'npm:prettier@2.8.8/parser-html.js', }, packages: { 'devextreme': { defaultExtension: 'js', }, 'devextreme-react': { main: 'index.js', }, 'devextreme/events/utils': { main: 'index', }, 'devextreme/localization/messages': { format: 'json', defaultExtension: 'json', }, 'devextreme/events': { main: 'index', }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js', }, }, packageConfigPaths: [ 'npm:@devextreme/*/package.json', 'npm:@devextreme/runtime@3.0.13/inferno/package.json', ], babelOptions: { sourceMaps: false, stage0: true, react: true, }, }; System.config(window.config);
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render(<App />, document.getElementById('app'));
<!DOCTYPE html> <html lang="en"> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=5.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/24.1.3/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="styles.css" /> <script src="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script> <script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script> <script type="text/javascript" src="config.js"></script> <script type="text/javascript"> System.import("./index.tsx"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>
.right-side { position: absolute; right: 1px; top: 6px; } .logo { line-height: 48px; } .logo img { vertical-align: middle; margin: 0 5px; } .dx-row.dx-data-row .employee { color: #bf4e6a; font-weight: bold; } #gridContainer { margin: 20px 0; height: 400px; }

In this demo, you can use the SelectBox component to filter the grid's dataSource. The "All" item calls the clearFilter() method and the other items call the filter(filterExpr) method.