Edit State Management
Our DataGrid component manages its edit state automatically. If your use case requires full control over the editing process, you can use the API members below to manage state manually. In this demo, we manage state with a help of the RxJS library.
Component Properties
-
editing.editRowKey
The key for the row being edited. -
editing.editColumnName
The name or data field of the column being edited. -
editing.changes
Pending row changes.
Use these properties to access and change edit state. Two-way bind them to component properties so that you can get and set the properties at runtime. In this demo, we bind the editRowKey and changes properties to display their values under the DataGrid.
Utility Method
- DevExpress.data.applyChanges(data, changes, options)
Applies an array of changes to a source data array.
Event Handlers
-
onSaving / onSaved
Functions that are called before / after pending row changes are saved via the UI or programmatically. -
onEditCanceling / onEditCanceled
Functions that are called before / after editing is canceled and pending row changes are discarded.
Use these functions to perform custom actions. In this demo, the onSaving function sends pending changes to a server. The function's parameter e contains fields for this capability. To implement the same in your application, follow these steps:
-
Disable built-in edit state management
Set thee.cancelfield to true. -
Send a request to the server
Pending changes are stored in thee.changesarray. This array has only a single element in all edit modes, except for batch. Check if this element is not empty and send it to the server (see theprocessSavingmethod inapp.component.tsand thesaveChangemethod inapp.service.ts). -
Apply the same changes to the DataGrid's data source
If the server successfully saves changes, call the applyChanges method to save the same changes in the DataGrid's data source (see theupdateOrdersmethod inapp.service.ts). -
Reset edit state
Assign null to the editRowKey and an empty array to the changes property (see theprocessSavingmethod inapp.component.ts).
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-load-panel [position]="loadPanelPosition" [visible]="isLoading">
</dx-load-panel>
<dx-data-grid
id="gridContainer"
keyExpr="OrderID"
[dataSource]="orders$ | async"
[showBorders]="true"
[repaintChangesOnly]="true"
(onSaving)="onSaving($event)"
>
<dxo-editing
mode="row"
[allowAdding]="true"
[allowDeleting]="true"
[allowUpdating]="true"
[(changes)]="changes"
[(editRowKey)]="editRowKey"
></dxo-editing>
<dxi-column dataField="OrderID" [allowEditing]="false"></dxi-column>
<dxi-column dataField="ShipName"></dxi-column>
<dxi-column dataField="ShipCountry"></dxi-column>
<dxi-column dataField="ShipCity"></dxi-column>
<dxi-column dataField="ShipAddress"></dxi-column>
<dxi-column dataField="OrderDate" dataType="date"></dxi-column>
<dxi-column dataField="Freight"></dxi-column>
</dx-data-grid>
<div class="options">
<div class="caption">Options</div>
<div class="option">
<span>Edit Row Key:</span>
<div id="editRowKey">{{
editRowKey === null ? "null" : editRowKey.toString()
}}</div>
</div>
<div class="option">
<span>Changes:</span>
<div id="changes">{{ changesText }}</div>
</div>
</div>
import {
NgModule, Component, OnInit, OnDestroy, enableProdMode,
} from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { HttpClientModule } from '@angular/common/http';
import { DxDataGridModule, DxLoadPanelModule } from 'devextreme-angular';
import { Observable, Subscription } from 'rxjs';
import { Service, Order, Change } from './app.service';
if (!/localhost/.test(document.location.host)) {
enableProdMode();
}
@Component({
selector: 'demo-app',
templateUrl: 'app/app.component.html',
styleUrls: ['app/app.component.css'],
providers: [Service],
preserveWhitespaces: true,
})
export class AppComponent implements OnInit, OnDestroy {
ordersSubscription: Subscription;
orders$: Observable<Order[]>;
changes: Change<Order>[] = [];
editRowKey?: number = null;
isLoading = false;
loadPanelPosition = { of: '#gridContainer' };
constructor(private service: Service) { }
ngOnInit() {
this.orders$ = this.service.getOrders();
this.isLoading = true;
this.ordersSubscription = this.orders$.subscribe(() => {
this.isLoading = false;
});
}
get changesText(): string {
return JSON.stringify(this.changes.map((change) => ({
type: change.type,
key: change.type !== 'insert' ? change.key : undefined,
data: change.data,
})), null, ' ');
}
onSaving(e: any) {
const change = e.changes[0];
if (change) {
e.cancel = true;
e.promise = this.processSaving(change);
}
}
async processSaving(change: Change<Order>) {
this.isLoading = true;
try {
await this.service.saveChange(change);
this.editRowKey = null;
this.changes = [];
} finally {
this.isLoading = false;
}
}
ngOnDestroy() {
this.ordersSubscription.unsubscribe();
}
}
@NgModule({
imports: [
BrowserModule,
DxDataGridModule,
DxLoadPanelModule,
HttpClientModule,
],
declarations: [AppComponent],
bootstrap: [AppComponent],
})
export class AppModule { }
platformBrowserDynamic().bootstrapModule(AppModule);
::ng-deep #gridContainer {
height: 440px;
}
::ng-deep .options {
padding: 20px;
margin-top: 20px;
background-color: rgba(191, 191, 191, 0.15);
}
::ng-deep .caption {
margin-bottom: 10px;
font-weight: 500;
font-size: 18px;
}
::ng-deep .option {
margin-bottom: 10px;
}
::ng-deep .option > span {
position: relative;
margin-right: 10px;
}
::ng-deep .option > div {
display: inline-block;
font-weight: bold;
}
import { Injectable } from '@angular/core';
import { HttpClient, HttpParams } from '@angular/common/http';
import { BehaviorSubject, Observable } from 'rxjs';
import applyChanges from 'devextreme/data/apply_changes';
export class Order {
OrderID: number;
ShipName: string;
ShipCountry: string;
ShipCity: string;
ShipAddress: string;
OrderDate: string;
Freight: number;
}
export class Change<T> {
type: 'insert' | 'update' | 'remove';
key: any;
data: Partial<T>;
}
class Response<T> {
data: T[];
}
@Injectable()
export class Service {
private orders$ = new BehaviorSubject<Order[]>([]);
private url = 'https://js.devexpress.com/Demos/Mvc/api/DataGridWebApi';
constructor(private http: HttpClient) { }
updateOrders(change: Change<Order>, data: Order) {
change.data = data;
const orders = applyChanges(this.orders$.getValue(), [change], { keyExpr: 'OrderID' });
this.orders$.next(orders);
}
getOrders(): Observable<Order[]> {
this.http.get(`${this.url}/Orders?skip=700`, { withCredentials: true }).toPromise().then((data: Response<Order>) => {
this.orders$.next(data.data);
});
return this.orders$.asObservable();
}
async insert(change: Change<Order>): Promise<Order> {
const httpParams = new HttpParams({ fromObject: { values: JSON.stringify(change.data) } });
const httpOptions = { withCredentials: true, body: httpParams };
const data = await this.http.post<Order>(`${this.url}/InsertOrder`, httpParams, httpOptions).toPromise();
this.updateOrders(change, data);
return data;
}
async update(change: Change<Order>): Promise<Order> {
const httpParams = new HttpParams({ fromObject: { key: change.key, values: JSON.stringify(change.data) } });
const httpOptions = { withCredentials: true, body: httpParams };
const data = await this.http.put<Order>(`${this.url}/UpdateOrder`, httpParams, httpOptions).toPromise();
this.updateOrders(change, data);
return data;
}
async remove(change: Change<Order>): Promise<Order> {
const httpParams = new HttpParams({ fromObject: { key: change.key } });
const httpOptions = { withCredentials: true, body: httpParams };
const data = await this.http.delete<Order>(`${this.url}/DeleteOrder`, httpOptions).toPromise();
this.updateOrders(change, data);
return data;
}
async saveChange(change: Change<Order>): Promise<Order> {
switch (change.type) {
case 'insert':
return this.insert(change);
case 'update':
return this.update(change);
case 'remove':
return this.remove(change);
}
}
}
// 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/
window.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@4.3.5/lib/typescript.js',
'@angular/core': 'npm:@angular/core@12.2.16',
'@angular/platform-browser': 'npm:@angular/platform-browser@12.2.16',
'@angular/platform-browser-dynamic': 'npm:@angular/platform-browser-dynamic@12.2.16',
'@angular/forms': 'npm:@angular/forms@12.2.16',
'@angular/common': 'npm:@angular/common@12.2.16',
'@angular/compiler': 'npm:@angular/compiler@12.2.16',
'tslib': 'npm:tslib@2.3.1/tslib.js',
'rxjs': 'npm:rxjs@6.4.0',
'rrule': 'npm:rrule@2.6.6/dist/es5/rrule.js',
'luxon': 'npm:luxon@1.28.0/build/global/luxon.min.js',
'es6-object-assign': 'npm:es6-object-assign@1.1.0',
'devextreme': 'npm:devextreme@21.2.7/cjs',
'devextreme/bundles/dx.all': 'npm:devextreme@21.2.7/bundles/dx.all.js',
'jszip': 'npm:jszip@3.7.1/dist/jszip.min.js',
'devextreme-quill': 'npm:devextreme-quill@1.5.14/dist/dx-quill.min.js',
'devexpress-diagram': 'npm:devexpress-diagram@2.1.47',
'devexpress-gantt': 'npm:devexpress-gantt@4.0.13',
'devextreme-angular': 'npm:devextreme-angular@21.2.7',
'@devextreme/runtime': 'npm:@devextreme/runtime@2.3.14',
'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js',
'inferno-compat': 'npm:inferno-compat@7.4.11/dist/inferno-compat.min.js',
'inferno-create-element': 'npm:inferno-create-element@7.4.11/dist/inferno-create-element.min.js',
'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js',
'inferno-hydrate': 'npm:inferno-hydrate@7.4.11/dist/inferno-hydrate.min.js',
'inferno-clone-vnode': 'npm:inferno-clone-vnode@7.4.11/dist/inferno-clone-vnode.min.js',
'inferno-create-class': 'npm:inferno-create-class@7.4.11/dist/inferno-create-class.min.js',
'inferno-extras': 'npm:inferno-extras@7.4.11/dist/inferno-extras.min.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:@devextreme/*/package.json',
'npm:@devextreme/runtime@2.3.14/inferno/package.json',
'npm:@angular/*/package.json',
'npm:@angular/common@12.2.16/*/package.json',
'npm:rxjs@6.4.0/package.json',
'npm:rxjs@6.4.0/operators/package.json',
'npm:devextreme-angular@21.2.7/*/package.json',
'npm:devextreme-angular@21.2.7/ui/*/package.json',
'npm:devextreme-angular@21.2.7/package.json',
'npm:devexpress-diagram@2.1.47/package.json',
'npm:devexpress-gantt@4.0.13/package.json',
],
};
System.config(window.config);
<!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/21.2.7/css/dx.common.css" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/21.2.7/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.11.4/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>