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.
Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Thank you!
We appreciate your feedback.
We appreciate your feedback.
<dx-data-grid id="gridContainer"
[dataSource]="dataSource"
[showBorders]="true"
[remoteOperations]="true">
<dxi-column
dataField="OrderNumber"
dataType="number">
</dxi-column>
<dxi-column
dataField="OrderDate"
dataType="date">
</dxi-column>
<dxi-column
dataField="StoreCity"
dataType="string">
</dxi-column>
<dxi-column
dataField="StoreState"
dataType="string">
</dxi-column>
<dxi-column
dataField="Employee"
dataType="string">
</dxi-column>
<dxi-column
dataField="SaleAmount"
dataType="number"
format="currency">
</dxi-column>
<dxo-paging [pageSize]="12"></dxo-paging>
<dxo-pager
[showPageSizeSelector]="true"
[allowedPageSizes]="[8, 12, 20]"
></dxo-pager>
</dx-data-grid>
import { NgModule, Component, enableProdMode } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { HttpClient, HttpClientModule, HttpParams } from '@angular/common/http';
import { DxDataGridModule } from 'devextreme-angular';
import CustomStore from 'devextreme/data/custom_store';
if(!/localhost/.test(document.location.host)) {
enableProdMode();
}
@Component({
styleUrls: ['app/app.component.css'],
selector: 'demo-app',
templateUrl: 'app/app.component.html'
})
export class AppComponent {
dataSource: any = {};
constructor(httpClient: HttpClient) {
function isNotEmpty(value: any): boolean {
return value !== undefined && value !== null && value !== "";
}
this.dataSource = new CustomStore({
key: "OrderNumber",
load: function (loadOptions: any) {
let params: HttpParams = new HttpParams();
[
"skip",
"take",
"requireTotalCount",
"requireGroupCount",
"sort",
"filter",
"totalSummary",
"group",
"groupSummary"
].forEach(function(i) {
if (i in loadOptions && isNotEmpty(loadOptions[i]))
params = params.set(i, JSON.stringify(loadOptions[i]));
});
return httpClient.get('https://js.devexpress.com/Demos/WidgetsGalleryDataService/api/orders', { params: params })
.toPromise()
.then((data: any) => {
return {
data: data.data,
totalCount: data.totalCount,
summary: data.summary,
groupCount: data.groupCount
};
})
.catch(error => { throw 'Data Loading Error' });
}
});
}
}
@NgModule({
imports: [
BrowserModule,
DxDataGridModule,
HttpClientModule
],
declarations: [AppComponent],
bootstrap: [AppComponent]
})
export class AppModule { }
platformBrowserDynamic().bootstrapModule(AppModule);
// In real applications, you should not transpile code in the browser. You can see how to create your own application with Angular and DevExtreme here:
// https://js.devexpress.com/Documentation/Guide/Angular_Components/Getting_Started/Create_a_DevExtreme_Application/
System.config({
transpiler: 'ts',
typescriptOptions: {
module: "system",
emitDecoratorMetadata: true,
experimentalDecorators: true
},
meta: {
'typescript': {
"exports": "ts"
},
'devextreme/localization.js': {
"esModule": true
}
},
paths: {
'npm:': 'https://unpkg.com/'
},
map: {
'ts': 'npm:plugin-typescript@8.0.0/lib/plugin.js',
'typescript': 'npm:typescript@3.5.3/lib/typescript.js',
'@angular': 'npm:@angular',
'tslib': 'npm:tslib@2.0.3/tslib.js',
'rxjs': 'npm:rxjs@6.3.3',
'rrule': 'npm:rrule@2.6.6/dist/es5/rrule.js',
'luxon': 'npm:luxon@1.25.0/build/global/luxon.min.js',
'es6-object-assign': 'npm:es6-object-assign@1.1.0',
'devextreme': 'npm:devextreme@20.2.3',
'jszip': 'npm:jszip@3.5.0/dist/jszip.min.js',
'devextreme-quill': 'npm:devextreme-quill@0.9.5/dist/dx-quill.min.js',
'devexpress-diagram': 'npm:devexpress-diagram@2.0.0',
'devexpress-gantt': 'npm:devexpress-gantt@2.0.0',
'devextreme-angular': 'npm:devextreme-angular@20.2.3',
'preact': 'npm:preact@10.5.5/dist/preact.js',
'preact/hooks': 'npm:preact@10.5.5/hooks/dist/hooks.js'
},
packages: {
'app': {
main: './app.component.ts',
defaultExtension: 'ts'
},
'devextreme': {
defaultExtension: 'js'
},
'devextreme/events/utils': {
main: 'index'
},
'devextreme/events': {
main: 'index'
},
'es6-object-assign': {
main: './index.js',
defaultExtension: 'js'
}
},
packageConfigPaths: [
"npm:@angular/*/package.json",
"npm:@angular/common/*/package.json",
"npm:rxjs/package.json",
"npm:rxjs/operators/package.json",
"npm:devextreme-angular/*/package.json",
"npm:devextreme-angular/ui/*/package.json",
"npm:devextreme-angular/package.json",
"npm:devexpress-diagram/package.json",
"npm:devexpress-gantt/package.json",
]
});
<!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" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/20.2.3/css/dx.common.css" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/20.2.3/css/dx.light.css" />
<script src="https://unpkg.com/core-js@2.4.1/client/shim.min.js"></script>
<script src="https://unpkg.com/zone.js@0.10.2/dist/zone.js"></script>
<script src="https://unpkg.com/reflect-metadata@0.1.3/Reflect.js"></script>
<script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script>
<script src="config.js"></script>
<script>
System.import('app').catch(console.error.bind(console));
</script>
</head>
<body class="dx-viewport">
<div class="demo-container">
<demo-app>Loading...</demo-app>
</div>
</body>
</html>