React Data Grid - 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.

TS JS

Backend API

import React, { useCallback, useState } from 'react'; import DataGrid, { Column, type DataGridTypes, FilterRow, Selection, Pager, } from 'devextreme-react/data-grid'; import Button from 'devextreme-react/button'; import { query } from 'devextreme-react/common/data'; const MILLISECONDS_IN_DAY = 1000 * 60 * 60 * 24; const dataSource = { 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_Due_Date', 'Task_Status', 'ResponsibleEmployee/Employee_Full_Name', ], }; const selectionFilter = ['Task_Status', '=', 'Completed']; let dataGrid; const App = () => { const [taskCount, setTaskCount] = useState(0); const [peopleCount, setPeopleCount] = useState(0); const [avgDuration, setAvgDuration] = useState(0); // eslint-disable-next-line space-before-function-paren const calculateStatistics = useCallback(async () => { const selectedItems = await dataGrid.getSelectedRowsData(); const totalDuration = selectedItems.reduce((currentValue: number, item: { Task_Due_Date: number; Task_Start_Date: number; }) => { const duration = item.Task_Due_Date - item.Task_Start_Date; return currentValue + duration; }, 0); const averageDurationInDays = totalDuration / MILLISECONDS_IN_DAY / selectedItems.length; setTaskCount(selectedItems.length); setPeopleCount( query(selectedItems) .groupBy('ResponsibleEmployee.Employee_Full_Name') .toArray().length, ); setAvgDuration(Math.round(averageDurationInDays) || 0); }, []); const onInitialized = useCallback((e: DataGridTypes.InitializedEvent) => { dataGrid = e.component; calculateStatistics(); }, [calculateStatistics]); return ( <div> <DataGrid id="grid-container" dataSource={dataSource} showBorders={true} defaultSelectionFilter={selectionFilter} onInitialized={onInitialized} > <Selection mode="multiple" deferred={true} /> <FilterRow visible={true} /> <Pager visible={true} /> <Column caption="Subject" dataField="Task_Subject" /> <Column caption="Start Date" dataField="Task_Start_Date" width="auto" dataType="date" /> <Column caption="Due Date" dataField="Task_Due_Date" width="auto" dataType="date" /> <Column caption="Assigned To" dataField="ResponsibleEmployee.Employee_Full_Name" width="auto" allowSorting={false} /> <Column caption="Status" width="auto" dataField="Task_Status" /> </DataGrid> <div className="selection-summary center"> <Button id="calculateButton" text="Get statistics on the selected tasks" type="default" onClick={calculateStatistics} /> <div> <div className="column"> <span className="text count">Task count:</span>   <span className="value">{taskCount}</span> </div>   <div className="column"> <span className="text people-count">People assigned:</span>   <span className="value">{peopleCount}</span> </div>   <div className="column"> <span className="text avg-duration">Average task duration (days):</span>   <span className="value">{avgDuration}</span> </div> </div> </div> </div> ); }; export default App;

import React, { useCallback, useState } from 'react'; import DataGrid, { Column, FilterRow, Selection, Pager, } from 'devextreme-react/data-grid'; import Button from 'devextreme-react/button'; import { query } from 'devextreme-react/common/data'; const MILLISECONDS_IN_DAY = 1000 * 60 * 60 * 24; const dataSource = { 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', ], }; const selectionFilter = ['Task_Status', '=', 'Completed']; let dataGrid; const App = () => { const [taskCount, setTaskCount] = useState(0); const [peopleCount, setPeopleCount] = useState(0); const [avgDuration, setAvgDuration] = useState(0); // eslint-disable-next-line space-before-function-paren const calculateStatistics = useCallback(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; setTaskCount(selectedItems.length); setPeopleCount( query(selectedItems).groupBy('ResponsibleEmployee.Employee_Full_Name').toArray().length, ); setAvgDuration(Math.round(averageDurationInDays) || 0); }, []); const onInitialized = useCallback( (e) => { dataGrid = e.component; calculateStatistics(); }, [calculateStatistics], ); return ( <div> <DataGrid id="grid-container" dataSource={dataSource} showBorders={true} defaultSelectionFilter={selectionFilter} onInitialized={onInitialized} > <Selection mode="multiple" deferred={true} /> <FilterRow visible={true} /> <Pager visible={true} /> <Column caption="Subject" dataField="Task_Subject" /> <Column caption="Start Date" dataField="Task_Start_Date" width="auto" dataType="date" /> <Column caption="Due Date" dataField="Task_Due_Date" width="auto" dataType="date" /> <Column caption="Assigned To" dataField="ResponsibleEmployee.Employee_Full_Name" width="auto" allowSorting={false} /> <Column caption="Status" width="auto" dataField="Task_Status" /> </DataGrid> <div className="selection-summary center"> <Button id="calculateButton" text="Get statistics on the selected tasks" type="default" onClick={calculateStatistics} /> <div> <div className="column"> <span className="text count">Task count:</span>   <span className="value">{taskCount}</span> </div>   <div className="column"> <span className="text people-count">People assigned:</span>   <span className="value">{peopleCount}</span> </div>   <div className="column"> <span className="text avg-duration">Average task duration (days):</span>   <span className="value">{avgDuration}</span> </div> </div> </div> </div> ); }; export default App;

import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.tsx'; ReactDOM.render( <App />, document.getElementById('app'), );

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/25.1.6/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="styles.css" /> <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.tsx"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>

#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; } .value { font-size: 40px; display: inline-block; vertical-align: middle; } .text { text-align: left; white-space: normal; display: inline-block; vertical-align: middle; } .avg-duration { width: 100px; } .count { width: 40px; } .people-count { width: 65px; }

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.