DevExtreme v24.1 is now available.

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

Your search did not match any results.

JavaScript/jQuery 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.
Backend API
$(() => { const MILLISECONDS_IN_DAY = 1000 * 60 * 60 * 24; let dataGrid; $('#grid-container').dxDataGrid({ 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', ], }, selection: { mode: 'multiple', deferred: true, }, filterRow: { visible: true, }, onInitialized(e) { dataGrid = e.component; calculateStatistics(); }, selectionFilter: ['Task_Status', '=', 'Completed'], showBorders: true, columns: [{ caption: 'Subject', dataField: 'Task_Subject', }, { caption: 'Start Date', dataField: 'Task_Start_Date', width: 'auto', dataType: 'date', }, { caption: 'Due Date', dataField: 'Task_Due_Date', width: 'auto', dataType: 'date', }, { caption: 'Assigned To', dataField: 'ResponsibleEmployee.Employee_Full_Name', width: 'auto', allowSorting: false, }, { caption: 'Status', width: 'auto', dataField: 'Task_Status', }], }).dxDataGrid('instance'); async function calculateStatistics() { 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; $('#tasks-count').text(selectedItems.length); $('#people-count').text( DevExpress.data.query(selectedItems) .groupBy('ResponsibleEmployee.Employee_Full_Name') .toArray().length, ); $('#avg-duration').text(Math.round(averageDurationInDays) || 0); } $('#calculateButton').dxButton({ text: 'Get statistics on the selected tasks', type: 'default', onClick: calculateStatistics, }); });
<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" 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" /> <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script> <script>window.jQuery || document.write(decodeURIComponent('%3Cscript src="js/jquery.min.js"%3E%3C/script%3E'))</script> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/24.1.6/css/dx.light.css" /> <script src="js/dx.all.js"></script> <link rel="stylesheet" type="text/css" href="styles.css" /> <script src="index.js"></script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="grid-container"></div> <div class="selection-summary center"> <div id="calculateButton"></div> <div> <div class="column"> <span class="text count">Task count:</span> <span class="value" id="tasks-count">0</span> </div> <div class="column"> <span class="text people-count">People assigned:</span> <span class="value" id="people-count">0</span> </div> <div class="column"> <span class="text avg-duration"> Average task duration (days): </span> <span class="value" id="avg-duration">0</span> </div> </div> </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 JavaScript 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.