DevExtreme v23.2 is now available.

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

Your search did not match any results.

Filtering

Documentation

This example demonstrates the DataGrid’s built-in filtering and searching capabilities. The filter row, located under the column headers, allows a user to type any value and select filter operations. With the header filter, which is called by clicking the filter icon in any column header, a user can choose from a set of predefined values. The search panel at the top of the DataGrid allows searching for values in all columns at once.

Backend API
<template> <div> <DxDataGrid id="gridContainer" ref="dataGridRef" :data-source="orders" :show-borders="true" key-expr="ID" > <DxFilterRow :visible="showFilterRow" :apply-filter="currentFilter" /> <DxHeaderFilter :visible="showHeaderFilter" /> <DxSearchPanel :visible="true" :width="240" placeholder="Search..." /> <DxColumn :width="140" data-field="OrderNumber" caption="Invoice Number" > <DxHeaderFilter :group-interval="10000"/> </DxColumn> <DxColumn :width="120" :calculate-filter-expression="calculateFilterExpression" data-field="OrderDate" alignment="right" data-type="date" > <DxHeaderFilter :data-source="orderDateHeaderFilter"/> </DxColumn> <DxColumn :width="180" data-field="DeliveryDate" alignment="right" data-type="datetime" format="M/d/yyyy, HH:mm" /> <DxColumn :editor-options="saleAmountEditorOptions" data-field="SaleAmount" alignment="right" format="currency" > <DxHeaderFilter :data-source="saleAmountHeaderFilter"/> </DxColumn> <DxColumn data-field="Employee"/> <DxColumn data-field="CustomerStoreCity" caption="City" > <DxHeaderFilter> <DxSearch :enabled="true"/> </DxHeaderFilter> </DxColumn> </DxDataGrid> <div class="options"> <div class="caption">Options</div> <div class="option"> <span>Apply Filter </span> <DxSelectBox id="useFilterApplyButton" :items="applyFilterTypes" :input-attr="{ 'aria-label': 'Filter' }" v-model:value="currentFilter" :disabled="!showFilterRow" value-expr="key" display-expr="name" /> </div> <div class="option"> <DxCheckBox v-model:value="showFilterRow" text="Filter Row" @valueChanged="clearFilter()" /> </div> <div class="option"> <DxCheckBox v-model:value="showHeaderFilter" text="Header Filter" @valueChanged="clearFilter()" /> </div> </div> </div> </template> <script setup lang="ts"> import { ref } from 'vue'; import { DxDataGrid, DxColumn, DxHeaderFilter, DxSearch, DxSearchPanel, DxFilterRow, DxDataGridTypes, } from 'devextreme-vue/data-grid'; import DxSelectBox from 'devextreme-vue/select-box'; import DxCheckBox from 'devextreme-vue/check-box'; import { Options as DataSourceOptions } from 'devextreme/data/data_source'; import { orders, Order } from './data.ts'; const applyFilterTypes = [ { key: 'auto', name: 'Immediately', }, { key: 'onClick', name: 'On Button Click', }, ]; const showFilterRow = ref(true); const showHeaderFilter = ref(true); const currentFilter = ref(applyFilterTypes[0].key); const dataGridRef = ref<DxDataGrid | null>(null); const saleAmountEditorOptions = { format: 'currency', showClearButton: true }; const saleAmountHeaderFilter = [ { text: 'Less than $3000', value: ['SaleAmount', '<', 3000], }, { text: '$3000 - $5000', value: [ ['SaleAmount', '>=', 3000], ['SaleAmount', '<', 5000], ], }, { text: '$5000 - $10000', value: [ ['SaleAmount', '>=', 5000], ['SaleAmount', '<', 10000], ], }, { text: '$10000 - $20000', value: [ ['SaleAmount', '>=', 10000], ['SaleAmount', '<', 20000], ], }, { text: 'Greater than $20000', value: ['SaleAmount', '>=', 20000], }, ]; const clearFilter = () => dataGridRef.value?.instance?.clearFilter(); const getOrderDay = (rowData: Order) => (new Date(rowData.OrderDate)).getDay(); function calculateFilterExpression( this: DxDataGridTypes.Column, value: any, selectedFilterOperations: string | null, target: string, ) { const column = this; if (target === 'headerFilter' && value === 'weekends') { return [[getOrderDay, '=', 0], 'or', [getOrderDay, '=', 6]]; } return column.defaultCalculateFilterExpression!(value, selectedFilterOperations, target); } const orderDateHeaderFilter = (options: { dataSource: DataSourceOptions }) => { const { dataSource } = options; dataSource.postProcess = (results) => { results.push({ text: 'Weekends', value: 'weekends', }); return results; }; }; </script> <style scoped> #gridContainer { height: 440px; } .options { padding: 20px; margin-top: 20px; background-color: rgba(191, 191, 191, 0.15); } .caption { font-size: 18px; font-weight: 500; } .option { margin-top: 10px; } .option > span { margin-right: 10px; } .option > .dx-selectbox { display: inline-block; vertical-align: middle; } </style>
window.exports = window.exports || {}; window.config = { transpiler: 'plugin-babel', meta: { '*.vue': { loader: 'vue-loader', }, '*.ts': { loader: 'demo-ts-loader', }, '*.svg': { loader: 'svg-loader', }, 'devextreme/time_zone_utils.js': { 'esModule': true, }, 'devextreme/localization.js': { 'esModule': true, }, 'devextreme/viz/palette.js': { 'esModule': true, }, }, paths: { 'root:': '../../../../../', 'npm:': 'https://unpkg.com/', }, map: { 'vue': 'npm:vue@3.3.4/dist/vue.esm-browser.js', 'vue-loader': 'npm:dx-systemjs-vue-browser@1.1.1/index.js', 'demo-ts-loader': 'root:utils/demo-ts-loader.js', 'svg-loader': 'root:utils/svg-loader.js', 'mitt': 'npm:mitt/dist/mitt.umd.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@23.2.5/cjs', 'devextreme-vue': 'npm:devextreme-vue@23.2.5/cjs', 'jszip': 'npm:jszip@3.10.1/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.6.4/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.2.5/dist/dx-diagram.js', 'devexpress-gantt': 'npm:devexpress-gantt@4.1.51/dist/dx-gantt.js', '@devextreme/runtime': 'npm:@devextreme/runtime@3.0.12', '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', '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.4/standalone.js', 'prettier/parser-html': 'npm:prettier@2.8.4/parser-html.js', }, packages: { 'devextreme-vue': { main: 'index.js', }, 'devextreme': { defaultExtension: 'js', }, 'devextreme/events/utils': { main: 'index', }, 'devextreme/events': { main: 'index', }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js', }, }, packageConfigPaths: [ 'npm:@devextreme/*/package.json', 'npm:@devextreme/runtime@3.0.12/inferno/package.json', ], babelOptions: { sourceMaps: false, stage0: true, }, }; System.config(window.config);
export type Order = { ID: number; OrderNumber: number; OrderDate: string; DeliveryDate: string; SaleAmount: number; Terms: string; CustomerStoreCity: string; Employee: string; }; export const orders: Order[] = [{ ID: 1, OrderNumber: 35703, OrderDate: '2017/04/10', DeliveryDate: '2017/04/13 9:00', SaleAmount: 11800, Terms: '15 Days', CustomerStoreCity: 'Los Angeles, CA', Employee: 'Harv Mudd', }, { ID: 4, OrderNumber: 35711, OrderDate: '2017/01/12', DeliveryDate: '2017/01/13 9:00', SaleAmount: 16050, Terms: '15 Days', CustomerStoreCity: 'San Jose, CA', Employee: 'Jim Packard', }, { ID: 5, OrderNumber: 35714, OrderDate: '2017/01/22', DeliveryDate: '2017/01/27 9:00', SaleAmount: 14750, Terms: '15 Days', CustomerStoreCity: 'Las Vegas, NV', Employee: 'Harv Mudd', }, { ID: 7, OrderNumber: 35983, OrderDate: '2017/02/07', DeliveryDate: '2017/02/10 13:00', SaleAmount: 3725, Terms: '15 Days', CustomerStoreCity: 'Denver, CO', Employee: 'Todd Hoffman', }, { ID: 11, OrderNumber: 38466, OrderDate: '2017/03/01', DeliveryDate: '2017/03/03 17:45', SaleAmount: 7800, Terms: '15 Days', CustomerStoreCity: 'Los Angeles, CA', Employee: 'Harv Mudd', }, { ID: 14, OrderNumber: 39420, OrderDate: '2017/02/15', DeliveryDate: '2017/02/17 11:45', SaleAmount: 20500, Terms: '15 Days', CustomerStoreCity: 'San Jose, CA', Employee: 'Jim Packard', }, { ID: 15, OrderNumber: 39874, OrderDate: '2017/02/04', DeliveryDate: '2017/02/10 15:00', SaleAmount: 9050, Terms: '30 Days', CustomerStoreCity: 'Las Vegas, NV', Employee: 'Harv Mudd', }, { ID: 18, OrderNumber: 42847, OrderDate: '2017/02/15', DeliveryDate: '2017/02/17 8:30', SaleAmount: 20400, Terms: '30 Days', CustomerStoreCity: 'Casper, WY', Employee: 'Todd Hoffman', }, { ID: 30, OrderNumber: 57429, OrderDate: '2017/05/16', DeliveryDate: '2017/05/19 11:45', SaleAmount: 11050, Terms: '30 Days', CustomerStoreCity: 'Phoenix, AZ', Employee: 'Clark Morgan', }, { ID: 32, OrderNumber: 58292, OrderDate: '2017/05/13', DeliveryDate: '2017/05/19 14:30', SaleAmount: 13500, Terms: '15 Days', CustomerStoreCity: 'Los Angeles, CA', Employee: 'Harv Mudd', }, { ID: 36, OrderNumber: 62427, OrderDate: '2017/01/27', DeliveryDate: '2017/02/03 18:00', SaleAmount: 23500, Terms: '15 Days', CustomerStoreCity: 'Las Vegas, NV', Employee: 'Harv Mudd', }, { ID: 39, OrderNumber: 65977, OrderDate: '2017/02/05', DeliveryDate: '2017/02/10 13:15', SaleAmount: 2550, Terms: '15 Days', CustomerStoreCity: 'Casper, WY', Employee: 'Todd Hoffman', }, { ID: 42, OrderNumber: 68428, OrderDate: '2017/04/10', DeliveryDate: '2017/04/14 11:30', SaleAmount: 10500, Terms: '15 Days', CustomerStoreCity: 'Los Angeles, CA', Employee: 'Harv Mudd', }, { ID: 43, OrderNumber: 69477, OrderDate: '2017/03/09', DeliveryDate: '2017/03/10 12:00', SaleAmount: 14200, Terms: '15 Days', CustomerStoreCity: 'Anaheim, CA', Employee: 'Harv Mudd', }, { ID: 46, OrderNumber: 72947, OrderDate: '2017/01/14', DeliveryDate: '2017/01/20 9:00', SaleAmount: 13350, Terms: '30 Days', CustomerStoreCity: 'Las Vegas, NV', Employee: 'Harv Mudd', }, { ID: 47, OrderNumber: 73088, OrderDate: '2017/03/25', DeliveryDate: '2017/03/31 17:15', SaleAmount: 8600, Terms: '30 Days', CustomerStoreCity: 'Reno, NV', Employee: 'Clark Morgan', }, { ID: 51, OrderNumber: 77297, OrderDate: '2017/04/30', DeliveryDate: '2017/05/05 18:00', SaleAmount: 10850, Terms: '30 Days', CustomerStoreCity: 'Phoenix, AZ', Employee: 'Clark Morgan', }, { ID: 56, OrderNumber: 84744, OrderDate: '2017/02/10', DeliveryDate: '2017/02/17 14:00', SaleAmount: 4650, Terms: '30 Days', CustomerStoreCity: 'Las Vegas, NV', Employee: 'Harv Mudd', }, { ID: 57, OrderNumber: 85028, OrderDate: '2017/05/17', DeliveryDate: '2017/05/19 12:00', SaleAmount: 2575, Terms: '30 Days', CustomerStoreCity: 'Reno, NV', Employee: 'Clark Morgan', }, { ID: 59, OrderNumber: 87297, OrderDate: '2017/04/21', DeliveryDate: '2017/04/28 9:00', SaleAmount: 14200, Terms: '30 Days', CustomerStoreCity: 'Casper, WY', Employee: 'Todd Hoffman', }, { ID: 65, OrderNumber: 94726, OrderDate: '2017/05/22', DeliveryDate: '2017/05/26 13:30', SaleAmount: 20500, Terms: '15 Days', CustomerStoreCity: 'San Jose, CA', Employee: 'Jim Packard', }, { ID: 66, OrderNumber: 95266, OrderDate: '2017/03/10', DeliveryDate: '2017/03/17 11:45', SaleAmount: 9050, Terms: '15 Days', CustomerStoreCity: 'Las Vegas, NV', Employee: 'Harv Mudd', }, { ID: 69, OrderNumber: 98477, OrderDate: '2017/01/01', DeliveryDate: '2017/01/06 9:00', SaleAmount: 23500, Terms: '15 Days', CustomerStoreCity: 'Casper, WY', Employee: 'Todd Hoffman', }, { ID: 78, OrderNumber: 174884, OrderDate: '2017/04/10', DeliveryDate: '2017/04/14 8:30', SaleAmount: 7200, Terms: '30 Days', CustomerStoreCity: 'Denver, CO', Employee: 'Todd Hoffman', }, { ID: 81, OrderNumber: 188877, OrderDate: '2017/02/11', DeliveryDate: '2017/02/17 16:00', SaleAmount: 8750, Terms: '30 Days', CustomerStoreCity: 'Phoenix, AZ', Employee: 'Clark Morgan', }, { ID: 82, OrderNumber: 191883, OrderDate: '2017/02/05', DeliveryDate: '2017/02/10 18:30', SaleAmount: 9900, Terms: '30 Days', CustomerStoreCity: 'Los Angeles, CA', Employee: 'Harv Mudd', }, { ID: 83, OrderNumber: 192474, OrderDate: '2017/01/21', DeliveryDate: '2017/01/27 12:45', SaleAmount: 12800, Terms: '30 Days', CustomerStoreCity: 'Anaheim, CA', Employee: 'Harv Mudd', }, { ID: 84, OrderNumber: 193847, OrderDate: '2017/03/21', DeliveryDate: '2017/03/24 9:00', SaleAmount: 14100, Terms: '30 Days', CustomerStoreCity: 'San Diego, CA', Employee: 'Harv Mudd', }, { ID: 85, OrderNumber: 194877, OrderDate: '2017/03/06', DeliveryDate: '2017/03/10 18:15', SaleAmount: 4750, Terms: '30 Days', CustomerStoreCity: 'San Jose, CA', Employee: 'Jim Packard', }, { ID: 86, OrderNumber: 195746, OrderDate: '2017/05/26', DeliveryDate: '2017/06/02 17:00', SaleAmount: 9050, Terms: '30 Days', CustomerStoreCity: 'Las Vegas, NV', Employee: 'Harv Mudd', }, { ID: 87, OrderNumber: 197474, OrderDate: '2017/03/02', DeliveryDate: '2017/03/03 11:00', SaleAmount: 6400, Terms: '30 Days', CustomerStoreCity: 'Reno, NV', Employee: 'Clark Morgan', }, { ID: 88, OrderNumber: 198746, OrderDate: '2017/05/09', DeliveryDate: '2017/05/12 15:45', SaleAmount: 15700, Terms: '30 Days', CustomerStoreCity: 'Denver, CO', Employee: 'Todd Hoffman', }, { ID: 91, OrderNumber: 214222, OrderDate: '2017/02/08', DeliveryDate: '2017/02/10 9:45', SaleAmount: 11050, Terms: '30 Days', CustomerStoreCity: 'Phoenix, AZ', Employee: 'Clark Morgan', }];
import { createApp } from 'vue'; import App from './App.vue'; createApp(App).mount('#app');
<!DOCTYPE html> <html> <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=1.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/23.2.5/css/dx.light.css" /> <script type="module"> import * as vueCompilerSFC from "https://unpkg.com/@vue/compiler-sfc@3.3.4/dist/compiler-sfc.esm-browser.js"; window.vueCompilerSFC = vueCompilerSFC; </script> <script src="https://unpkg.com/typescript@4.2.4/lib/typescript.js"></script> <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.ts"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"> </div> </div> </body> </html>