Web API Service
Documentation
This example demonstrates the DataGrid widget communicating with a Web API service. All data editing and data processing operations are delegated to the server. The DevExtreme.AspNet.Data extension’s DevExpress.data.AspNet.createStore method configures access to the server from the client. The server implementation is available under the DataGridWebApiController tab in the ASP.NET MVC version of this demo.
Feel free to share demo-related thoughts here.
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
[dataSource]="dataSource"
[remoteOperations]="true"
height="600"
showBorders="true"
[masterDetail]="{ enabled: true, template: 'detail' }">
<dxo-filter-row [visible]="true"></dxo-filter-row>
<dxo-header-filter [visible]="true"></dxo-header-filter>
<dxo-group-panel [visible]="true"></dxo-group-panel>
<dxo-scrolling mode="virtual"></dxo-scrolling>
<dxo-editing
mode="row"
[allowAdding]="true"
[allowUpdating]="true"
[allowDeleting]="true">
</dxo-editing>
<dxo-grouping [autoExpandAll]="false"></dxo-grouping>
<dxi-column dataField="CustomerID" caption="Customer">
<dxi-validation-rule type="stringLength" max="5" message="The field Customer must be a string with a maximum length of 5."></dxi-validation-rule>
<dxo-lookup [dataSource]="customersData" valueExpr="Value" displayExpr="Text"></dxo-lookup>
</dxi-column>
<dxi-column dataField="OrderDate" dataType="date">
<dxi-validation-rule type="required" message="The OrderDate field is required."></dxi-validation-rule>
</dxi-column>
<dxi-column dataField="Freight">
<dxo-header-filter
groupInterval="100"></dxo-header-filter>
<dxi-validation-rule type="range" min="0" max="2000" message="The field Freight must be between 0 and 2000."></dxi-validation-rule>
</dxi-column>
<dxi-column dataField="ShipCountry">
<dxi-validation-rule type="stringLength" max="15" message="The field ShipCountry must be a string with a maximum length of 15."></dxi-validation-rule>
</dxi-column>
<dxi-column dataField="ShipVia" caption="Shipping Company" dataType="number">
<dxo-lookup [dataSource]="shippersData" valueExpr="Value" displayExpr="Text"></dxo-lookup>
</dxi-column>
<div *dxTemplate="let order of 'detail'">
<dx-data-grid
[dataSource]="getMasterDetailGridDataSource(order.data.OrderID)"
showBorders="true">
</dx-data-grid>
</div>
<dxo-summary>
<dxi-total-item
column="Freight"
summaryType="sum">
<dxo-value-format
type="decimal"
[precision]="2"
></dxo-value-format>
</dxi-total-item>
<dxi-group-item
column="Freight"
summaryType="sum">
<dxo-value-format
type="decimal"
[precision]="2"
></dxo-value-format>
</dxi-group-item>
<dxi-group-item
summaryType="count">
</dxi-group-item>
</dxo-summary>
</dx-data-grid>
import { NgModule, Component, enableProdMode, ChangeDetectionStrategy } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { DxDataGridModule } from 'devextreme-angular';
import * as AspNetData from "devextreme-aspnet-data-nojquery";
if(!/localhost/.test(document.location.host)) {
enableProdMode();
}
@Component({
styleUrls: ['app/app.component.css'],
selector: 'demo-app',
templateUrl: 'app/app.component.html',
changeDetection: ChangeDetectionStrategy.OnPush
})
export class AppComponent {
customersData: any;
shippersData: any;
dataSource: any;
url: string;
masterDetailDataSource: any;
constructor() {
this.url = "https://js.devexpress.com/Demos/Mvc/api/DataGridWebApi";
this.dataSource = AspNetData.createStore({
key: "OrderID",
loadUrl: this.url + "/Orders",
insertUrl: this.url + "/InsertOrder",
updateUrl: this.url + "/UpdateOrder",
deleteUrl: this.url + "/DeleteOrder",
onBeforeSend: function(method, ajaxOptions) {
ajaxOptions.xhrFields = { withCredentials: true };
}
});
this.customersData = AspNetData.createStore({
key: "Value",
loadUrl: this.url + "/CustomersLookup",
onBeforeSend: function(method, ajaxOptions) {
ajaxOptions.xhrFields = { withCredentials: true };
}
});
this.shippersData = AspNetData.createStore({
key: "Value",
loadUrl: this.url + "/ShippersLookup",
onBeforeSend: function(method, ajaxOptions) {
ajaxOptions.xhrFields = { withCredentials: true };
}
});
}
getMasterDetailGridDataSource(id: number) : any {
return {
store: AspNetData.createStore({
loadUrl: this.url + '/OrderDetails',
loadParams: { orderID : id },
onBeforeSend: function(method, ajaxOptions) {
ajaxOptions.xhrFields = { withCredentials: true };
}
})
};
}
}
@NgModule({
imports: [
BrowserModule,
DxDataGridModule
],
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://github.com/DevExpress/devextreme-angular/blob/master/README.md
System.config({
transpiler: 'ts',
typescriptOptions: {
module: "commonjs",
emitDecoratorMetadata: true,
experimentalDecorators: true
},
meta: {
'typescript': {
"exports": "ts"
},
'devextreme-aspnet-data-nojquery': {
"esModule": true
}
},
paths: {
'npm:': 'https://unpkg.com/'
},
map: {
'ts': 'npm:plugin-typescript@8.0.0/lib/plugin.js',
'typescript': 'npm:typescript@3.4.5/lib/typescript.js',
'@angular/core': 'npm:@angular/core@8.0.0/bundles/core.umd.js',
'@angular/common': 'npm:@angular/common@8.0.0/bundles/common.umd.js',
'@angular/compiler': 'npm:@angular/compiler@8.0.0/bundles/compiler.umd.js',
'@angular/platform-browser': 'npm:@angular/platform-browser@8.0.0/bundles/platform-browser.umd.js',
'@angular/platform-browser-dynamic': 'npm:@angular/platform-browser-dynamic@8.0.0/bundles/platform-browser-dynamic.umd.js',
'@angular/router': 'npm:@angular/router@8.0.0/bundles/router.umd.js',
'@angular/forms': 'npm:@angular/forms@8.0.0/bundles/forms.umd.js',
'@angular/common/http': 'npm:@angular/common@8.0.0/bundles/common-http.umd.js',
'tslib': 'npm:tslib/tslib.js',
'rxjs': 'npm:rxjs@6.3.3',
'rxjs/operators': 'npm:rxjs@6.3.3/operators',
'devextreme': 'npm:devextreme@19.1',
'jszip': 'npm:jszip@3.1.3/dist/jszip.min.js',
'quill': 'npm:quill@1.3.6/dist/quill.js',
'devexpress-diagram': 'npm:devexpress-diagram',
'devextreme-angular': 'npm:devextreme-angular@19.1',
'devextreme-aspnet-data-nojquery': 'npm:devextreme-aspnet-data-nojquery@2.4.2'
},
packages: {
'app': {
main: './app.component.ts',
defaultExtension: 'ts'
},
'devextreme': {
defaultExtension: 'js'
},
'rxjs': { main: 'index.js', defaultExtension: 'js' },
'rxjs/operators': { main: 'index.js', defaultExtension: 'js' },
'devextreme-angular': {
main: 'index.js',
defaultExtension: 'js'
}
}
});
<!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/19.1.5/css/dx.common.css" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/19.1.5/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.6.25/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>