DevExtreme v24.1 is now available.

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

Your search did not match any results.

Deferred Selection

If you enable deferred row selection, the grid does not request selected rows' data with every selection change. For example, if a user clicks the checkbox in the column header to select all the rows, the grid does not immediately fetch all data from the server.

This is helpful in the following cases:

  • You process data on the server and do not want to load the selected rows' data.
  • You do process selected records on the client, but want to reduce the number of requests that are sent.
Backend API
<template> <div> <DxDataGrid id="grid-container" :data-source="dataSource" :show-borders="true" :selection-filter="selectionFilter" :on-initialized="onInitialized" > <DxSelection :deferred="true" mode="multiple" /> <DxFilterRow :visible="true"/> <DxColumn caption="Subject" data-field="Task_Subject" /> <DxColumn caption="Start Date" data-field="Task_Start_Date" width="auto" data-type="date" /> <DxColumn caption="Due Date" data-field="Task_Due_Date" width="auto" data-type="date" /> <DxColumn :allow-sorting="false" caption="Assigned To" data-field="ResponsibleEmployee.Employee_Full_Name" width="auto" /> <DxColumn caption="Status" width="auto" data-field="Task_Status" /> </DxDataGrid> <div class="selection-summary center"> <DxButton id="calculateButton" :on-click="calculateStatistics" text="Get statistics on the selected tasks" type="default" /> <div> <div class="column"> <span class="text count">Task count: </span> <span class="value">{{ taskCount }}</span> </div> <div class="column"> <span class="text people-count">People assigned: </span> <span class="value">{{ peopleCount }}</span> </div> <div class="column"> <span class="text avg-duration">Average task duration (days): </span> <span class="value">{{ avgDuration }}</span> </div> </div> </div> </div> </template> <script setup lang="ts"> import { ref } from 'vue'; import { DxDataGrid, DxColumn, DxFilterRow, DxSelection, DxDataGridTypes, } from 'devextreme-vue/data-grid'; import DxButton from 'devextreme-vue/button'; import { Options as DataSourceOptions } from 'devextreme/data/data_source'; import query from 'devextreme/data/query'; import 'devextreme/data/odata/store'; const MILLISECONDS_IN_DAY = 1000 * 60 * 60 * 24; 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_Due_Date', 'Task_Status', 'ResponsibleEmployee/Employee_Full_Name', ], }; let dataGrid: DxDataGrid['instance']; const selectionFilter = ['Task_Status', '=', 'Completed']; const taskCount = ref(0); const peopleCount = ref(0); const avgDuration = ref(0); const calculateStatistics = async() => { const selectedItems = await dataGrid.getSelectedRowsData(); const totalDuration = selectedItems.reduce((currentValue, item) => { const duration = item.Task_Due_Date - item.Task_Start_Date; return currentValue + duration; }, 0); const averageDurationInDays = totalDuration / MILLISECONDS_IN_DAY / selectedItems.length; taskCount.value = selectedItems.length; peopleCount.value = query(selectedItems) .groupBy('ResponsibleEmployee.Employee_Full_Name') .toArray().length; avgDuration.value = Math.round(averageDurationInDays) || 0; }; const onInitialized = (e: DxDataGridTypes.InitializedEvent) => { dataGrid = e.component!; calculateStatistics(); }; </script> <style> #grid-container { height: 400px; } .center { text-align: center; } .selection-summary { border: 1px solid rgba(161, 161, 161, 0.2); padding: 25px; } .column { margin: 20px 30px 0 0; display: inline-block; white-space: nowrap; text-align: right; } .column:nth-child(2) { padding: 0 4px; } .value { font-size: 40px; display: inline-block; vertical-align: middle; } .text { text-align: left; white-space: normal; display: inline-block; vertical-align: middle; margin-right: 4px; } .avg-duration { width: 100px; } .count { width: 40px; } .people-count { width: 65px; } </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.2.47/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@24.1.4/cjs', 'devextreme-vue': 'npm:devextreme-vue@24.1.4/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.10/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', '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-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.13/inferno/package.json', ], babelOptions: { sourceMaps: false, stage0: true, }, }; System.config(window.config);
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/24.1.4/css/dx.light.css" /> <script type="module"> import * as vueCompilerSFC from "https://unpkg.com/@vue/compiler-sfc@3.4.16/dist/compiler-sfc.esm-browser.js"; window.vueCompilerSFC = vueCompilerSFC; </script> <script src="https://unpkg.com/typescript@4.9.5/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> </body> </html>

This demo illustrates the second scenario. Deferred selection is enabled and the selected rows are only requested when you click the button below the grid.

To enable deferred selection in your application, set the selection.deferred property to true.

To specify the initially selected rows, use the selectionFilter property. The DataGrid updates this property's value at runtime and you can always access the applied filter. In this demo, the selectionFilter selects rows whose Status is Completed.

To load the selected rows' data, call the getSelectedRowsData() method. In deferred selection mode, this method returns a Promise. You can access row data in its fulfillment handler. In this demo, the getSelectedRowsData() method gets data objects that are then used to calculate statistics for the selected tasks.