Angular Tree Grid Cell Editing

El componente Ignite UI for Angular Tree Grid proporciona excelentes capacidades de manipulación de datos y una potente API para operaciones Angular CRUD. De forma predeterminada, la cuadrícula de árbol se utiliza en la edición de celdas y se mostrarán diferentes editores según el tipo de datos de la columna, gracias a la plantilla de edición de celdas predeterminada. Además, puede definir sus propias plantillas personalizadas para acciones de actualización de datos y anular el comportamiento predeterminado para confirmar y descartar cualquier cambio.

Angular Tree Grid cell editing and edit templates Example

Note

Al utilizar igxCellEditor con cualquier tipo de componente de edición, el flujo de navegación del teclado se verá interrumpido. Lo mismo se aplica a la edición directa de la celda personalizada que ingresa al modo de edición. Esto se debe a que el focus permanecerá en el cell element, no en el componente del editor que hemos agregado: igxSelect, igxCombo, etc. Es por eso que debemos aprovechar la directiva igxFocus, que moverá el foco directamente en el elemento de la celda. -componente de celda y preservará a fluent editing flow de la celda/fila.

Edición de celdas

Editing through UI

Puede ingresar al modo de edición para una celda específica, cuando una celda editable está enfocada de una de las siguientes maneras:

al hacer doble clic;
con un solo clic: un solo clic ingresará al modo de edición solo si la celda seleccionada previamente estaba en modo de edición y la celda actualmente seleccionada es editable. Si la celda previamente seleccionada no estaba en modo de edición, un solo clic seleccionará la celda sin ingresar al modo de edición;
en la tecla presione Enter;
en la tecla presione F2;

Puede salir del modo de edición sin realizar los cambios de una de las siguientes maneras:

en la tecla presione Escape;
cuando realiza operaciones de clasificación, filtrado, búsqueda y ocultación;

Puede salir del modo de edición y confirmar los cambios de una de las siguientes maneras:

en la tecla presione Enter;
en la tecla presione F2;
en la tecla presione Tab;
con un solo clic en otra celda: cuando haga clic en otra celda en la cuadrícula de árbol, se enviarán sus cambios.
operaciones como paginación, cambio de tamaño, anclar o mover saldrán del modo de edición y se enviarán los cambios.

Note

La celda permanece en modo de edición cuando se desplaza vertical u horizontalmente o hace clic fuera de la cuadrícula de árbol. Esto es válido tanto para la edición de celdas como para la edición de filas.

Editing through API

También puede modificar el valor de la celda a través de la API IgxTreeGrid, pero solo si está definida la clave principal:

public updateCell() {
    this.treeGrid.updateCell(newValue, rowID, 'Age');
}

Otra forma de actualizar la celda es directamente mediante el método update de IgxGridCell:

public updateCell() {
    const cell = this.treeGrid.getCellByColumn(rowIndex, 'Age');
    // You can also get cell by rowID if primary key is defined
    // const cell = this.treeGrid.getCellByKey(rowID, 'Age');
    cell.update(9999);
}

Cell Editing Templates

Puede ver y obtener más información sobre las plantillas de edición de celdas predeterminadas en el tema de edición general.

Si desea proporcionar una plantilla personalizada que se aplicará cuando una celda esté en modo de edición, puede utilizar la igxCellEditordirectiva . Para hacer esto, debe pasar una ng-template marcada con la directiva igxCellEditor y vincular correctamente su control personalizado al cell.editValue:

<igx-column field="class" header="Class" [editable]="true">
    <ng-template igxCellEditor let-cell="cell" let-value>
        <igx-select class="cell-select" [(ngModel)]="cell.editValue" [igxFocus]="true">
            <igx-select-item *ngFor="let class of classes" [value]="class">
                {{ class }}
            </igx-select-item>
        </igx-select>
    </ng-template>
</igx-column>

Este código se utiliza en el siguiente ejemplo que implementa un IgxSelectComponent en las celdas de las columnas Race, Class y Alignment.

Note

Cualquier cambio realizado en el editValue de la celda en el modo de edición activará el evento de edición apropiado al salir y se aplicará al estado de la transacción (si las transacciones están habilitadas).

Note

La plantilla de celda igxCell controla cómo se muestran las celdas de una columna cuando se encuentra fuera del modo de edición. La directiva de plantilla de edición de celdas igxCellEditor maneja cómo se muestran las celdas de una columna en modo de edición y controla el valor de edición de la celda editada.

Note

Para obtener más información sobre cómo configurar columnas y sus plantillas, puede consultar la documentación para la configuración de Columnas de cuadrícula.

CRUD operations

Note

Tenga en cuenta que cuando realice alguna operación CRUD, todas las canalizaciones aplicadas, como filtrado, clasificación y agrupación, se volverán a aplicar y su vista se actualizará automáticamente.

The IgxTreeGridComponent provides a straightforward API for basic CRUD operations.

Adding a new record

El componente Tree Grid expone el método addRow que agregará los datos proporcionados a la propia fuente de datos.

public addNewChildRow() {
    // Adding a new record
    // Assuming we have a `getNewRecord` method returning the new row data
    // And specifying the parentRowID.
    const record = this.getNewRecord();
    this.treeGrid.addRow(record, 1);
}

Updating data in the Tree Grid

La actualización de datos en Tree Grid se logra mediante los métodos updateRow y updateCell, pero solo si se define la clave principal para la cuadrícula. También puede actualizar directamente un valor de celda y/o fila a través de sus respectivos métodos update.

// Updating the whole row
this.treeGrid.updateRow(newData, this.selectedCell.cellID.rowID);

// Just a particular cell through the Tree Grid API
this.treeGrid.updateCell(newData, this.selectedCell.cellID.rowID, this.selectedCell.column.field);

// Directly using the cell `update` method
this.selectedCell.update(newData);

// Directly using the row `update` method
const row = this.treeGrid.getRowByKey(rowID);
row.update(newData);

Deleting data from the Tree Grid

Tenga en cuenta que el método deleteRow() eliminará la fila especificada solo si se define la clave principal.

// Delete row through Tree Grid API
this.treeGrid.deleteRow(this.selectedCell.cellID.rowID);
// Delete row through row object
const row = this.treeGrid.getRowByIndex(rowIndex);
row.delete();

Estos pueden conectarse a interacciones del usuario, no necesariamente relacionadas con igx-tree-grid; por ejemplo, un clic en un botón:

<button igxButton igxRipple (click)="deleteRow($event)">Delete Row</button>

Cell validation on edit event

Usando los eventos de edición de la cuadrícula, podemos alterar la forma en que el usuario interactúa con la cuadrícula. En este ejemplo, validaremos una celda según los datos ingresados en ella vinculándola al evento cellEdit. Si el nuevo valor de la celda no cumple con nuestros criterios predefinidos, evitaremos que llegue a la fuente de datos cancelando el evento (event.cancel = true). También mostraremos un mensaje de error personalizado usando IgxToast.

Lo primero que debemos hacer es vincularnos al evento de la grilla:

<igx-tree-grid (cellEdit)="handleCellEdit($event)"
...>
...
</igx-tree-grid>

cellEdit se emite cada vez que el valor de cualquier celda está a punto de confirmarse. En nuestra definición handleCellEdit, debemos asegurarnos de verificar nuestra columna específica antes de realizar cualquier acción:

export class MyTreeGridEventsComponent {
    public handleCellEdit(event: IGridEditEventArgs): void {
        const column = event.column;
        if (column.field === 'Age') {
            if (event.newValue < 18) {
                event.cancel = true;
                this.toast.message = 'Employees must be at least 18 years old!';
                this.toast.open();
            }
        } else if (column.field === 'HireDate') {
            if (event.newValue > new Date().getTime()) {
                event.cancel = true;
                this.toast.message = 'The employee hire date must be in the past!';
                this.toast.open();
            }
        }
    }
}

Aquí, estamos validando dos columnas. Si el usuario intenta establecer un valor no válido para la edad de un empleado (menos de 18) o su fecha de contratación (una fecha futura), se cancelará la edición (el valor no se enviará) y se mostrará un brindis con un mensaje de error. .

El resultado de la validación anterior aplicada a nuestro igx-tree-grid se puede ver en la siguiente demostración:

Estilismo

IgxTreeGrid permite diseñar sus celdas a través de la Ignite UI for Angular. El tema de la cuadrícula expone una amplia gama de propiedades, que permiten a los usuarios diseñar muchos aspectos diferentes de la cuadrícula.

En los pasos a continuación, veremos cómo puede diseñar la celda de la cuadrícula en modo de edición y cómo puede definir el alcance de esos estilos.

Para utilizar la biblioteca de temas Ignite UI, primero debemos importar el archivo index del tema en nuestros estilos globales:

Importing style library

@use "igniteui-angular/theming" as *;

// IMPORTANT: Prior to Ignite UI for Angular version 13 use:
// @import '~igniteui-angular/lib/core/styles/themes/index';

Ahora podemos hacer uso de todas las funciones expuestas por la Ignite UI for Angular.

Defining a palette

Después de haber importado correctamente el archivo de índice, creamos una paleta personalizada que podemos usar. Definamos dos colores que nos gusten y usémoslos para construir una paleta con igx-palette:

$white: #fff;
$blue: #4567bb;

$color-palette: palette($primary: $white, $secondary: $blue);

Defining themes

Ahora podemos definir el tema usando nuestra paleta. Las celdas tienen el estilo del grid-theme, por lo que podemos usarlo para generar un tema para nuestro IgxTreeGrid:

$custom-grid-theme: grid-theme(
    $cell-editing-background: $blue,
    $cell-edited-value-color: $white,
    $cell-active-border-color: $white,
    $edit-mode-color: color($color-palette, "secondary", 200)
);

Applying the theme

La forma más sencilla de aplicar nuestro tema es con una declaración sass @include en el archivo de estilos global:

@include grid($custom-grid-theme);

De esta forma, el tema se aplicará a todas las cuadrículas de nuestra aplicación. Si deseamos aplicar este estilo personalizado solo a un componente específico, debemos definir el alcance del tema.

Scoped component theme

Para que el tema personalizado afecte solo a nuestro componente específico, podemos mover todos los estilos que acabamos de definir desde el archivo de estilos globales al archivo de estilo de nuestro componente personalizado (incluida la importación del archivo index).

De esta manera, debido a ViewEncapsulation de Angular, nuestros estilos se aplicarán solo a nuestro componente personalizado.

Note

Si el componente utiliza una ViewEncapsulation Emulated, es necesario penetrar esta encapsulación usando::ng-deep para poder diseñar la cuadrícula.

Note

Envolvemos la declaración dentro de un selector:host para evitar que nuestros estilos afecten a elementos fuera de nuestro componente:

:host {
    ::ng-deep {
            @include grid($custom-grid-theme);
        }
    }
}

Styling Demo

Además de los pasos anteriores, también podemos diseñar los controles que se utilizan para las plantillas de edición de las celdas: igx-input-group, igx-datepicker y igx-checkbox

Note

La muestra no se verá afectada por el tema global seleccionado en Change Theme.

Angular Tree Grid Cell Editing