Vue Data Grid - Filtering API

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

Was this demo helpful?

Thank you!

Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.

Thank you for the feedback!

Backend API

<template> <div> <div class="left-side"> <div class="logo"> <img :src="'../../../../images/logo-devav.png'" alt="DEVAV"> <img :src="'../../../../images/logo-tasks.png'" alt="Tasks"> </div> </div> <div class="right-side"> <DxSelectBox :items="statuses" :value="statuses[0]" :input-attr="{ 'aria-label': 'Status' }" @value-changed="onValueChanged" /> </div> <DxDataGrid id="gridContainer" ref="dataGridRef" :data-source="dataSource" :column-auto-width="true" :show-borders="true" > <DxPager :visible="true"/> <DxColumn :width="80" data-field="Task_ID" /> <DxColumn data-field="Task_Start_Date" data-type="date" caption="Start Date" /> <DxColumn :allow-sorting="false" data-field="ResponsibleEmployee.Employee_Full_Name" css-class="employee" caption="Assigned To" /> <DxColumn :width="350" data-field="Task_Subject" caption="Subject" /> <DxColumn data-field="Task_Status" caption="Status" /> </DxDataGrid> </div> </template> <script setup lang="ts"> import { ref } from 'vue'; import { DxColumn, DxDataGrid, DxPager, } from 'devextreme-vue/data-grid'; import DxSelectBox, { type DxSelectBoxTypes } from 'devextreme-vue/select-box'; import 'devextreme-vue/common/data'; import { type DataSourceOptions } from 'devextreme-vue/common/data'; const dataSource: 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 dataGridRef = ref<DxDataGrid | null>(null); const onValueChanged = ({ value }: DxSelectBoxTypes.ValueChangedEvent) => { const dataGrid = dataGridRef.value!.instance!; if (value === 'All') { dataGrid.clearFilter(); } else { dataGrid.filter(['Task_Status', '=', value]); } }; </script> <style scoped> .right-side { position: absolute; right: 1px; top: 6px; } .logo { line-height: 48px; } .logo img { vertical-align: middle; margin: 0 5px; } .logo img:first-child { margin-right: 9px; } .dx-row.dx-data-row .employee { color: #bf4e6a; font-weight: bold; } #gridContainer { margin: 20px 0; height: 400px; } </style>

import { createApp } from 'vue'; import App from './App.vue'; createApp(App).mount('#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/25.1.3/css/dx.light.css" /> <script type="module"> import * as vueCompilerSFC from "https://cdn.jsdelivr.net/npm/@vue/compiler-sfc@3.4.27/dist/compiler-sfc.esm-browser.js"; window.vueCompilerSFC = vueCompilerSFC; </script> <script src="https://cdn.jsdelivr.net/npm/typescript@5.4.5/lib/typescript.js"></script> <script src="https://cdn.jsdelivr.net/npm/core-js@2.6.12/client/shim.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/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>

filter() / filter(filterExpr)
Gets or sets a filter expression for the grid's dataSource.
filterValue
A filter expression that is applied with the following UI elements: filter row, header filter, filter builder.
getCombinedFilter() / getCombinedFilter(returnDataField)
Gets the total filter that includes filters from the UI elements and the filter applied to the dataSource. If you specify the returnDataField parameter, the returned value contains data field names instead of getters.
clearFilter() / clearFilter(filterName)
Discards all filters applied to the DataGrid. If you specify the filterName parameter, this method discards all filters of a specific type.

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.