Angular Grid 一括編集とトランザクション
IgxGrid の一括編集機能は、TransactionService
に基づいています。トランザクション サービス クラス階層
トピックに従って、igxTransactionService
の概要と、その実装方法の詳細を確認してください。
以下は、Grid コンポーネントに対して一括編集を有効にする方法の詳細な例です。
最速で機能豊富な Angular Data Grid は、ページング、ソート、フィルタリング、グループ化、PDF および Excel へのエクスポートなどの機能を提供します。究極のアプリ構築エクスペリエンスとデータ操作に必要なすべてが揃っています。
Angular Grid 一括編集とトランザクションの例
以下のサンプルは、grid にプロバイダーのトランザクションがあり、batchEditing
と行編集が有効にされています。行編集全体を確定後にトランザクションが追加されるようにします。
import { NgModule } from "@angular/core";
import { FormsModule } from "@angular/forms";
import { BrowserModule } from "@angular/platform-browser";
import { BrowserAnimationsModule } from "@angular/platform-browser/animations";
import { AppComponent } from "./app.component";
import { GridBatchEditingSampleComponent } from "./grid/grid-batch-editing/grid-batch-editing-sample.component";
import {
IgxGridModule,
IgxDialogModule,
IgxButtonModule,
IgxFocusModule
} from "igniteui-angular";
import { IgxPreventDocumentScrollModule } from "./directives/prevent-scroll.directive";
@NgModule({
bootstrap: [AppComponent],
declarations: [
AppComponent,
GridBatchEditingSampleComponent
],
imports: [
BrowserModule,
BrowserAnimationsModule,
FormsModule,
IgxPreventDocumentScrollModule,
IgxGridModule,
IgxDialogModule,
IgxButtonModule,
IgxFocusModule
],
providers: [],
entryComponents: [],
schemas: []
})
export class AppModule {}
ts/* eslint-disable @typescript-eslint/naming-convention */
import { Component, OnInit, ViewChild } from '@angular/core';
import { IgxDialogComponent, IgxGridComponent, Transaction } from 'igniteui-angular';
import { DATA } from '../../data/nwindData';
import { generateRandomInteger } from '../../data/utils';
@Component({
selector: 'app-grid-row-edit',
styleUrls: [`grid-batch-editing-sample.component.scss`],
templateUrl: 'grid-batch-editing-sample.component.html'
})
export class GridBatchEditingSampleComponent implements OnInit {
@ViewChild('grid', { read: IgxGridComponent, static: true }) public grid: IgxGridComponent;
@ViewChild(IgxDialogComponent, { static: true }) public dialog: IgxDialogComponent;
public data: any[];
public transactionsData: Transaction[] = [];
private addProductId: number;
public ngOnInit(): void {
this.data = DATA;
this.addProductId = this.data.length + 1;
}
public addRow() {
this.grid.addRow({
CategoryID: generateRandomInteger(1, 10),
Discontinued: generateRandomInteger(1, 10) % 2 === 0,
OrderDate: new Date(generateRandomInteger(2000, 2050),
generateRandomInteger(0, 11), generateRandomInteger(1, 25))
.toISOString().slice(0, 10),
ProductID: this.addProductId++,
ProductName: 'Product with index ' + generateRandomInteger(0, 20),
QuantityPerUnit: (generateRandomInteger(1, 10) * 10).toString() + ' pcs.',
ReorderLevel: generateRandomInteger(10, 20),
SupplierID: generateRandomInteger(1, 20),
UnitPrice: generateRandomInteger(10, 1000),
UnitsInStock: generateRandomInteger(1, 100),
UnitsOnOrder: generateRandomInteger(1, 20)
});
}
public deleteRow(id) {
this.grid.deleteRow(id);
}
public undo() {
/* exit edit mode and commit changes */
this.grid.endEdit(true);
this.grid.transactions.undo();
}
public redo() {
/* exit edit mode and commit changes */
this.grid.endEdit(true);
this.grid.transactions.redo();
}
public openCommitDialog() {
this.transactionsData = this.grid.transactions.getAggregatedChanges(true);
this.dialog.open();
}
public commit() {
this.grid.transactions.commit(this.data);
this.dialog.close();
}
public discard() {
this.grid.transactions.clear();
this.dialog.close();
}
public stateFormatter(value: any) {
return JSON.stringify(value);
}
public typeFormatter(value: string) {
return value.toUpperCase();
}
public classFromType(type: string): string {
return `transaction--${type.toLowerCase()}`;
}
}
ts<div class="grid__wrapper">
<igx-grid [igxPreventDocumentScroll]="true" #grid [batchEditing]="true" [data]="data" [primaryKey]="'ProductID'" width="100%" height="500px"
[rowEditable]="true">
<igx-column [editable]="false">
<ng-template igxCell let-cell="cell" let-val>
<button igxButton (click)="deleteRow(cell.id.rowID)"
[disabled]="cell.row.deleted">Delete</button>
</ng-template>
</igx-column>
<igx-column field="ProductID" header="Product ID" [editable]="false"></igx-column>
<igx-column field="ProductName" header="Product Name" [dataType]="'string'"></igx-column>
<igx-column field="UnitPrice" header="Unit Price" [dataType]="'string'"></igx-column>
<igx-column field="UnitsOnOrder" header="Units On Order" dataType="number"></igx-column>
<igx-column field="UnitsInStock" header="Units In Stock" dataType="number"></igx-column>
<igx-column field="QuantityPerUnit" header="Quantity Per Unit" [dataType]="'string'"></igx-column>
<igx-column field="ReorderLevel" header="Reorder Level" dataType="number"></igx-column>
<igx-column field="SupplierID" header="Supplier ID" dataType="number"></igx-column>
<igx-column field="CategoryID" header="Category ID" dataType="number"></igx-column>
<igx-column field="Discontinued" header="Discontinued" [dataType]="'boolean'"></igx-column>
</igx-grid>
<div class="buttons-row">
<button igxButton (click)="addRow()">Add Row</button>
<div class="buttons-wrapper">
<button igxButton [disabled]="!grid.transactions.canUndo" (click)="undo()">Undo</button>
<button igxButton [disabled]="!grid.transactions.canRedo" (click)="redo()">Redo</button>
<button igxButton [disabled]="grid.transactions.getAggregatedChanges(false).length < 1"
(click)="openCommitDialog()">Commit</button>
</div>
</div>
<igx-dialog #dialog title="Submit the following transactions?">
<igx-grid [igxPreventDocumentScroll]="true" #dialogGrid [data]="transactionsData" [rowHeight]="64" [primaryKey]="'id'"
width="600px" height="300px" [emptyGridMessage]="'No available transactions'">
<igx-column field="id" header="ID" [dataType]="'string'" width="100px"></igx-column>
<igx-column field="type" header="Type" width="150px" [sortable]="true">
<ng-template igxCell let-cell="cell" let-val>
<span [class]="classFromType(val)">{{ typeFormatter(val) }}</span>
</ng-template>
</igx-column>
<igx-column field="newValue" header="Value" width="900px">
<ng-template igxCell let-cell="cell" let-val>
<span class="transaction-log">{{ stateFormatter(val) }}</span>
</ng-template>
</igx-column>
</igx-grid>
<div class="buttons-wrapper">
<button igxButton (click)="commit()">Commit</button>
<button igxButton (click)="discard()">Discard</button>
<button igxButton (click)="dialog.close()">Cancel</button>
</div>
</igx-dialog>
</div>
html.grid__wrapper {
margin: 15px;
}
h4 {
text-align: center;
padding-top: 2%;
padding-bottom: 2%;
}
.buttons-row {
display: flex;
flex-direction: row;
justify-content: space-between;
padding: 5px;
}
.buttons-wrapper {
display: flex;
flex-direction: row;
justify-content: center;
padding: 10px 0;
}
.transaction--update, .transaction--delete, .transaction--add {
font-weight: 600;
}
.transaction--add {
color: #6b3;
}
.transaction--update {
color: #4a71b9;
}
.transaction--delete {
color: #ee4920;
}
.transaction-log {
word-wrap: none;
}
scss
このサンプルが気に入りましたか? 完全な Ignite UI for Angularツールキットにアクセスして、すばやく独自のアプリの作成を開始します。無料でダウンロードできます。
トランザクション ステートは、すべての更新、追加、削除された行、そして最後のステートで構成されます。
使用方法
IgxGridModule
を app.module.ts ファイルにインポートします。
// app.module.ts
...
import { IgxGridModule } from 'igniteui-angular';
@NgModule({
...
imports: [..., IgxGridModule],
...
})
export class AppModule {}
typescript
次に、Grid から batchEditing
を有効にします。
<igx-grid [data]="data" [batchEditing]="true">
...
</igx-grid>
html
これにより、igx-grid に Transaction
サービスの適切なインスタンスが提供されます。適切な TransactionService
は TransactionFactory
を通じて提供されます。この内部実装の詳細については、トランザクション トピックを参照してください。
一括編集を有効にした後、バインドされたデータ ソースと rowEditable
を true に設定して IgxGrid
を定義し、バインドします。
<igx-grid #grid [batchEditing]="true" [data]="data" [primaryKey]="'ProductID'" width="100%" height="500px"
[rowEditable]="true">
...
</igx-grid>
...
<button igxButton [disabled]="!grid.transactions.canUndo" (click)="undo()">Undo</button>
<button igxButton [disabled]="!grid.transactions.canRedo" (click)="redo()">Redo</button>
<button igxButton [disabled]="grid.transactions.getAggregatedChanges(false).length < 1"
(click)="openCommitDialog(dialogGrid)">Commit</button>
...
html
以下のコード例は、transactions
API (undo、redo、commit) の使用方法を示します。
export class GridBatchEditingSampleComponent {
@ViewChild('grid', { read: IgxGridComponent }) public gridRowEditTransaction: IgxGridComponent;
public undo() {
/* exit edit mode and commit changes */
this.grid.endEdit(true);
this.grid.transactions.undo();
}
public redo() {
/* exit edit mode and commit changes */
this.grid.endEdit(true);
this.grid.transactions.redo()
}
public commit() {
this.grid.transactions.commit(this.data);
this.toggle.close();
}
}
typescript
トランザクション API は編集の終了を処理しないので、自分で行う必要があります。そうしないと、Grid
は編集モードのままになります。これを行う 1 つの方法は、それぞれのメソッドで endEdit
を呼び出すことです。
rowEditable
プロパティを無効にすると Grid
を変更してセル変更でトランザクションを作成し、UI で行編集オーバーレイを公開しません。
一括編集のリモート ページング デモ
import { NgModule } from "@angular/core";
import { FormsModule } from "@angular/forms";
import { BrowserModule } from "@angular/platform-browser";
import { BrowserAnimationsModule } from "@angular/platform-browser/animations";
import { AppComponent } from "./app.component";
import { RemotePagingBatchEditingComponent } from "./grid/grid-batchEditing-remotePaging/batch-editing-remote-paging.component";
import {
IgxGridModule,
IgxDialogModule,
IgxButtonModule
} from "igniteui-angular";
import { RemotePagingService } from "./services/remotePaging.service";
import { HttpClientModule } from "@angular/common/http";
import { IgxPreventDocumentScrollModule } from "./directives/prevent-scroll.directive";
@NgModule({
bootstrap: [AppComponent],
declarations: [
AppComponent,
RemotePagingBatchEditingComponent
],
imports: [
BrowserModule,
BrowserAnimationsModule,
FormsModule,
IgxPreventDocumentScrollModule,
IgxGridModule,
IgxDialogModule,
IgxButtonModule,
HttpClientModule
],
providers: [RemotePagingService],
entryComponents: [],
schemas: []
})
export class AppModule {}
ts/* eslint-disable @typescript-eslint/naming-convention */
import { AfterViewInit, Component, OnDestroy, OnInit, ViewChild, ViewEncapsulation } from '@angular/core';
import { GridPagingMode, IgxDialogComponent, IgxGridComponent, Transaction } from 'igniteui-angular';
import { Observable } from 'rxjs';
import { RemotePagingService } from '../../services/remotePaging.service';
@Component({
encapsulation: ViewEncapsulation.None,
providers: [RemotePagingService],
selector: 'app-remote-paging-batch-editing',
styleUrls: ['./batch-editing-remote-paging.component.scss'],
templateUrl: './batch-editing-remote-paging.component.html'
})
export class RemotePagingBatchEditingComponent implements OnInit, AfterViewInit, OnDestroy {
@ViewChild('grid1', { static: true }) public grid1: IgxGridComponent;
@ViewChild(IgxDialogComponent, { static: true }) public dialog: IgxDialogComponent;
public page = 0;
public totalCount = 0;
public data: Observable<any[]>;
public selectOptions = [5, 10, 15, 25, 50];
public transactionsData: Transaction[] = [];
public mode = GridPagingMode.Remote;
private _perPage = 10;
private _dataLengthSubscriber;
private _recordOnServer = 0;
private _totalPagesOnServer = 0;
constructor(private remoteService: RemotePagingService) {
}
public get perPage(): number {
return this._perPage;
}
public set perPage(val: number) {
this._perPage = val;
this._totalPagesOnServer = Math.floor(this._recordOnServer / this.perPage);
this.paginate(0);
}
public ngOnInit() {
this.data = this.remoteService.remoteData.asObservable();
this._dataLengthSubscriber = this.remoteService.getDataLength().subscribe((data) => {
this.totalCount = data;
this._recordOnServer = data;
this._totalPagesOnServer = Math.floor(this.totalCount / this.perPage);
this.grid1.isLoading = false;
});
}
public ngOnDestroy() {
if (this._dataLengthSubscriber) {
this._dataLengthSubscriber.unsubscribe();
}
}
public ngAfterViewInit() {
this.grid1.isLoading = true;
this.remoteService.getData(0, this.perPage);
}
public paginate(page: number) {
this.grid1.endEdit(true);
if (page > this._totalPagesOnServer) {
if (this.page !== this._totalPagesOnServer) {
const skipEl = this._totalPagesOnServer * this.perPage;
this.remoteService.getData(skipEl, this.perPage);
}
this.page = page - this._totalPagesOnServer;
this.page = page;
return;
} else {
this.page = 0;
}
this.page = page;
const skip = this.page * this.perPage;
this.remoteService.getData(skip, this.perPage);
}
public addRow() {
this.totalCount++;
const newID = this.generateRandomInteger(this.totalCount, this.totalCount * 100);
this.grid1.addRow({
ID: newID, ProductName: 'Product Name', QuantityPerUnit: 'Quantity per Unit',
SupplierName: 'Supplier Name', UnitsInStock: 1, Rating: 1
});
}
public deleteRow(rowID) {
if (!this.grid1.data.some(d => d.ID === rowID)) {
this.totalCount--;
}
this.grid1.deleteRow(rowID);
if (this.grid1.dataView.length === 1) {
this.paginate(this.page - 1);
}
}
public generateRandomInteger(start: number, end: number) {
return Math.floor(Math.random() * (end - start + 1)) + start;
}
public undo() {
this.grid1.transactions.undo();
}
public redo() {
this.grid1.transactions.redo();
}
public openCommitDialog() {
this.transactionsData = this.grid1.transactions.getAggregatedChanges(true);
this.dialog.open();
}
public commit() {
this.grid1.transactions.commit(this.grid1.data);
this.dialog.close();
}
public cancel() {
this.dialog.close();
}
public discard() {
this.grid1.transactions.clear();
this.totalCount = this._recordOnServer;
this._totalPagesOnServer = Math.floor(this._recordOnServer / this.perPage);
this.paginate(this._totalPagesOnServer);
this.dialog.close();
}
public get hasTransactions(): boolean {
return this.grid1.transactions.getAggregatedChanges(false).length > 0;
}
public stateFormatter(value: string) {
return JSON.stringify(value);
}
public typeFormatter(value: string) {
return value.toUpperCase();
}
public classFromType(type: string): string {
return `transaction--${type.toLowerCase()}`;
}
}
ts<div class="grid__wrapper">
<igx-grid [igxPreventDocumentScroll]="true" #grid1 [batchEditing]="true" [data]="data | async" width="100%" height="580px" [pagingMode]="mode"
[rowEditable]="true" [primaryKey]="'ID'">
<igx-paginator #paginator
[totalRecords]="totalCount"
[page]="page"
[(perPage)]="perPage"
[selectOptions]="selectOptions"
[displayDensity]="grid1.displayDensity"
(pageChange)="paginate($event)">
</igx-paginator>
<igx-grid-toolbar>
<igx-grid-toolbar-actions>
<button igxButton (click)="addRow()">Add Row</button>
<button igxButton [disabled]="!grid1.transactions.canUndo" (click)="undo()">Undo</button>
<button igxButton [disabled]="!grid1.transactions.canRedo" (click)="redo()">Redo</button>
<button igxButton [disabled]="!hasTransactions" (click)="openCommitDialog()">Commit</button>
</igx-grid-toolbar-actions>
</igx-grid-toolbar>
<igx-column [pinned]="true" [filterable]="false" [editable]="false">
<ng-template igxCell let-cell="cell" let-val>
<button igxButton (click)="deleteRow(cell.id.rowID)" [disabled]="cell.row.deleted">Delete</button>
</ng-template>
</igx-column>
<igx-column field="ID" [editable]="false"></igx-column>
<igx-column field="ProductName"></igx-column>
<igx-column field="QuantityPerUnit"></igx-column>
<igx-column field="SupplierName"></igx-column>
<igx-column field="UnitsInStock"></igx-column>
<igx-column field="Rating"></igx-column>
</igx-grid>
<igx-dialog title="Submit the following transactions?">
<igx-grid [igxPreventDocumentScroll]="true" #dialogGrid [data]="transactionsData" [rowHeight]="64" [primaryKey]="'id'"
width="600px" height="300px" [emptyGridMessage]="'No available transactions'">
<igx-column field="id" header="ID" [dataType]="'string'" width="100px"></igx-column>
<igx-column field="type" header="Type" width="150px" [sortable]="true">
</igx-column>
<igx-column field="newValue" header="Value" width="900px">
<ng-template igxCell let-cell="cell" let-val>
<span class="transaction-log">{{ stateFormatter(val) }}</span>
</ng-template>
</igx-column>
</igx-grid>
<div class="buttons-wrapper">
<button igxButton (click)="commit()">Commit</button>
<button igxButton (click)="discard()">Discard</button>
<button igxButton (click)="cancel()">Cancel</button>
</div>
</igx-dialog>
</div>
html.grid__wrapper {
margin: 0 auto;
padding: 16px;
}
.buttons-row {
display: flex;
flex-direction: row;
justify-content: space-between;
padding: 5px;
}
.buttons-wrapper {
display: flex;
flex-direction: row;
justify-content: center;
padding: 10px 0;
}
.transaction--update, .transaction--delete, .transaction--add {
font-weight: 600;
}
.transaction--add {
color: #6b3;
}
.transaction--update {
color: #4a71b9;
}
.transaction--delete {
color: #ee4920;
}
.transaction-log {
word-wrap: none;
}
scss