Custom Data Source

DevExtreme provides the CustomStore component to load and edit data from a custom data source. In this demo, the CustomStore fetches data from a custom remote server and displays it in the DataGrid.

The communication between the CustomStore and the server is organized as follows:

The CustomStore sends data processing settings to the server (see the load function in the code below).
The server applies these settings to data and returns the processed dataset (you should write the server-side code for this).

Each setting has information about a data operation (sorting, filtering, etc.) and is present only if this operation is declared as remote in the DataGrid's remoteOperations option. If your server does not support a certain operation, do not declare it as remote to perform it on the client.

For more information about the communication between the client and server in DevExtreme, refer to the following help topic: Server-Side Data Processing.

If your server does not support any data operations, set remoteOperations to false and implement the load function as described in the following help topic: Client-Side Data Processing.

See more Hide details

Prev Demo Next Demo

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.

Send Feedback

Thank you!
We appreciate your feedback.

jQuery

Angular

Vue

React

AngularJS

Copy to CodePen

Apply

Reset

$(function(){ function isNotEmpty(value) { return value !== undefined && value !== null && value !== ""; } var store = new DevExpress.data.CustomStore({ key: "OrderNumber", load: function (loadOptions) { var deferred = $.Deferred(), args = {}; [ "skip", "take", "requireTotalCount", "requireGroupCount", "sort", "filter", "totalSummary", "group", "groupSummary" ].forEach(function(i) { if (i in loadOptions && isNotEmpty(loadOptions[i])) args[i] = JSON.stringify(loadOptions[i]); }); $.ajax({ url: "https://js.devexpress.com/Demos/WidgetsGalleryDataService/api/orders", dataType: "json", data: args, success: function(result) { deferred.resolve(result.data, { totalCount: result.totalCount, summary: result.summary, groupCount: result.groupCount }); }, error: function() { deferred.reject("Data Loading Error"); }, timeout: 5000 }); return deferred.promise(); } }); $("#gridContainer").dxDataGrid({ dataSource: store, showBorders: true, remoteOperations: true, paging: { pageSize: 12 }, pager: { showPageSizeSelector: true, allowedPageSizes: [8, 12, 20] }, columns: [{ dataField: "OrderNumber", dataType: "number" }, { dataField: "OrderDate", dataType: "date" }, { dataField: "StoreCity", dataType: "string" }, { dataField: "StoreState", dataType: "string" }, { dataField: "Employee", dataType: "string" }, { dataField: "SaleAmount", dataType: "number", format: "currency" }] }).dxDataGrid("instance"); });

<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> <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" /> <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/20.2.4/css/dx.common.css" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/20.2.4/css/dx.light.css" /> <script src="https://cdn3.devexpress.com/jslib/20.2.4/js/dx.all.js"></script> <script src="index.js"></script> <link rel="stylesheet" type="text/css" href="styles.css" /> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="gridContainer"></div> </div> </body> </html>