Angular Tree Grid Row Editing

La cuadrícula de árbol proporciona una forma conveniente de realizar manipulaciones de datos mediante la edición en línea y una API potente para operaciones CRUD Angular. Haga clic en una fila y presione la tecla Enter o simplemente haga doble clic con el mouse en la fila que necesita modificarse.

Angular Tree Grid Row Editing Example

El siguiente ejemplo demuestra cómo habilitar la edición de filas en la cuadrícula de árbol. Cambiar el valor de una celda y luego hacer clic o navegar a otra celda en la misma fila no actualizará el valor de la fila hasta que se confirme usando el botón Listo o se descarte usando el botón Cancelar.

Note

Cuando una fila está en modo de edición, al hacer clic en una celda de otra fila se actuará como si se presionara el botón Listo: envíe todos los cambios de la fila anterior. Si la nueva celda que recibe el foco es editable, entonces la nueva fila también ingresa al modo de edición, mientras que si la celda no es editable, solo la fila anterior sale del modo de edición.

Row Editing Usage

Para empezar, importa elIgxTreeGridModule archivo en el app.module.ts:

// app.module.ts

...
import { IgxTreeGridModule } from 'igniteui-angular';

@NgModule({
    ...
    imports: [..., IgxTreeGridModule],
    ...
})
export class AppModule {}

Luego se define una Tree Grid con fuente de datos acotada yrowEditable se pone en verdadero:

<igx-tree-grid [data]="data" [primaryKey]="EmployeID" [foreignKey]="PID"
               [rowEditable]="true" [rowSelection]="'multiple'" [moving]="true">
    <igx-column *ngFor="let c of columns"
        [editable] ="c.editable"
        [field]="c.field"
        [dataType]="c.dataType"
        [header]="c.label"
        [resizable]="c.resizable"
        [sortable]="c.sortable"
        [filterable]="c.filterable">
    </igx-column>
</igx-tree-grid>

Note

La configuración de la clave principal es obligatoria para las operaciones de edición de filas.

Note

No es necesario para habilitar la edición de columnas individuales. Usar larowEditable propiedad en la Cuadrícula del Árbol significará que todas las filas con propiedad definidafield, excepto la principal, serán editables. Si quieres desactivar la edición para una columna específica, entonces configuras laeditable entrada de la columna comofalse.

import { Component, OnInit, ViewChild } from '@angular/core';
import { IgxTreeGridComponent } from 'igniteui-angular/grids/tree-grid';
// import { IgxTreeGridComponent } from '@infragistics/igniteui-angular'; for licensed package
import { FLAT_DATA } from './data';

@Component({
   providers: [],
    selector: 'app-tree-grid-row-editing-sample',
    styleUrls: ['tree-grid-row-editing-sample.component.scss'],
    templateUrl: 'tree-grid-row-editing-sample.component.html'
})
export class TreeGridRowEditSampleComponent implements OnInit {

    public data: any[];
    public columns: any[];

    @ViewChild('treeGrid') public treeGrid: IgxTreeGridComponent;
    public ngOnInit(): void {
        this.data = FLAT_DATA;

        this.columns = [
            { field: 'FirstName', label: 'First Name', resizable: true, sortable: true, filterable: true, editable: true, dataType: 'string' },
            { field: 'LastName', label: 'Last Name', resizable: false, sortable: false, filterable: false, editable: true, dataType: 'string' },
            { field: 'Title', label: 'Title', resizable: true, sortable: true, filterable: true, editable: true, dataType: 'string' },
            { field: 'HireDate', label: 'Hire Date', resizable: true, sortable: true, filterable: true, editable: true, dataType: 'date' }
        ];
    }
}

Note

La Tree Grid utiliza internamente un proveedorIgxBaseTransactionService que retiene los cambios pendientes de celda, hasta que el estado de la fila se envía o cancela.

Positioning

• La posición predeterminada de la superposición estará debajo de la fila que está en modo de edición.

• Si no hay espacio debajo de la fila, aparecerá una superposición encima de la fila.

• Una vez que se muestra, arriba o abajo, la superposición mantendrá esta posición durante el desplazamiento, hasta que se cierre la superposición.

Behavior

• Si la fila está en modo de edición, la edición continuará si se hace clic en una celda de la misma fila.

• Al hacer clic en el botón "Listo", finalizará la edición de la fila y enviará los cambios a la fuente de datos o a una transacción, si está disponible. Además, la fila saldrá del modo de edición.

• Al hacer clic en el botón "Cancelar", se revertirán todos los cambios actuales en la fila y la fila saldrá del modo de edición.

• Si la fila está en modo de edición, al hacer clic en una celda de otra fila finalizará la edición de la fila actual y se enviarán nuevos cambios en la fila (el mismo comportamiento al hacer clic en el botón "Listo"). Si la nueva celda que recibe el foco es editable, entonces la nueva fila también ingresa al modo de edición, mientras que si la celda no es editable, solo la fila anterior sale del modo de edición.

• Si la fila está en modo de edición y la cuadrícula de árbol se desplaza de modo que esa fila salga del área visible, esta última seguirá en modo de edición. Cuando se desplaza la Cuadrícula de árbol, para que la fila vuelva a ser visible, la fila seguirá en modo de edición. Cuando se hace clic fuera de la cuadrícula de árbol, la celda también permanecerá en modo de edición.

• Al realizar operaciones de clasificación, filtrado, búsqueda y ocultación, se revertirán todos los cambios actuales en la fila y la fila saldrá del modo de edición.

• Al realizar operaciones de paginación, cambio de tamaño, fijación y movimiento, saldrá del modo de edición y enviará el último valor.

• Cada celda modificada obtiene un estilo editado hasta que finaliza la edición de la fila. Este es el comportamiento cuando Tree Grid no cuenta con transacciones. Cuando las transacciones están disponibles, se aplica el estilo de edición de celda hasta que se confirmen todos los cambios.

Keyboard Navigation

• EnteryF2 entra en modo de edición de filas

• EscSale del modo de edición de fila y no envía ninguno de los cambios en las celdas que se hicieron mientras la fila estaba en modo edición.

• Tabmover el enfoque de una celda editable de la fila a la siguiente y de la celda editable más a la derecha a los botones CANCELAR y TERMINADO. La navegación desde el botón TERMINADO va a la celda editable más a la izquierda dentro de la fila editada actualmente.

Feature Integration

• Cualquier operación de cambio de datos finalizará las operaciones de edición de filas y enviará los cambios de filas actuales. Esto incluirá operaciones como ordenar, cambiar criterios de agrupación y filtrado, paginación, etc.

• Los resúmenes se actualizarán una vez finalizada la edición de la fila. Lo mismo es válido para otras funciones como ordenar, filtrar, etc.

Customizing Row Editing Overlay

Customizing Text

Personalizar el texto de la superposición de edición de filas es posible usando eligxRowEditTextDirective. LarowChangesCount propiedad queda expuesta y contiene el conteo de células modificadas.

<ng-template igxRowEditText let-rowChangesCount>
 Changes: {{rowChangesCount}}
</ng-template>

Customizing Buttons

Es posible personalizar los botones de la superposición de edición de filas usando eligxRowEditActionsDirective. Si quieres que los botones formen parte de la navegación del teclado, entonces cada uno de ellos debería tener eligxRowEditTabStopDirective.

<ng-template igxRowEditActions let-endRowEdit>
<button igxButton igxRowEditTabStop (click)="endRowEdit(false)">Cancel</button>
<button igxButton igxRowEditTabStop (click)="endRowEdit(true)">Apply</button>
</ng-template>

Estilismo

Usando la Ignite UI for Angular Theme Library, podemos modificar considerablemente la superposición de Edición de Filas. La superposición de Edición de Filas es un elemento compuesto: su interfaz está compuesta por un par de componentes más: -igx-bannerpara renderizar su contenido -igx-buttons se renderizan en la plantilla predeterminada (para losDone botones yCancel de ).

En el siguiente ejemplo, utilizaremos las opcionesbutton styling​banner-styling de estilo de esos dos componentes para personalizar la experiencia de la Edición de Filas de nuestro IgxTreeGrid. También estilizaremos el editor y el fondo de la célula actual para hacerlo más distintivo. Puedes aprender más sobre el estilizado de celdas en la sección de Estilizado Cel ·lo.

Import theme

La forma más sencilla de estilizar el banner de Edición de Filas es definir estilos enapp nuestro archivo de estilo global (normalmentestyles.scss). Lo primero que tenemos que hacer es importar elthemes/index archivo; esto nos da acceso a todas las herramientas potentes del framework Ignite UI for Angular Sass:

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

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

Una vez que hayamos importado el archivo de temas, podemos crear temas personalizados.

Definir el tema

Ahora podemos definir un personalizadobanner theme que afectará a nuestro fondo de edición de filas y utilizar una de las paletas predefinidas,$purple-palette a saber:

$banner-theme: banner-theme(
  $banner-background: #e3e3e3,
  $banner-message-color: color($purple-palette, "secondary", 600)
);

Aquí lo usamosmy-banner-palette junto conigx-color (expuesto por la biblioteca de temas) para generar nuestros colores.

Include the theme

Ahora solo tenemos que aplicar el tema con una frase Sass@include. Pasamos nuestros recién definidos$banner-theme a través de:css-vars mixin​

@include css-vars($banner-theme);

Component styles

Dado que la superposición de edición de filas hace uso de muchos temas de otros componentes, el estilo a través de los estilos globales puede afectar a otras partes de nuestra aplicación (por ejemplo, banners, botones, etc.). La mejor manera de evitarlo es limitar el tema del banner al archivo de estilo del componente específico al que se aplica.

Note

Si el componente utiliza unaEmulated ViewEncapsulation, es necesario penetrar esta encapsulación para::ng-deep estilizar la superposición de edición de filas de la cuadrícula.

// custom.component.scss

:host {
  ::ng-deep {
    @include css-vars($banner-theme);
  }
}

Con la sintaxis anterior, nuestro tema de banner personalizado se aplica correctamente a la superposición de edición de filas de la cuadrícula.

Custom Templates

Para personalizar aún más nuestra superposición de Edición de Filas, podemos pasar una plantilla personalizada para poder estilizar losDone botones yCancel por separado:

<!-- in component.html -->
<igx-tree-grid>
    <ng-template igxRowEditActions let-endRowEdit>
        <div class="custom-buttons">
            <button igxIconButton="flat" class="custom-button" igxRowEditTabStop (click)="endRowEdit(false)">
                <igx-icon>clear</igx-icon>
            </button>
            <button igxIconButton="flat" class="custom-button" igxRowEditTabStop (click)="endRowEdit(true)">
                <igx-icon>check</igx-icon>
            </button>
        </div>
    </ng-template>
</igx-tree-grid>

Después de definir nuestros botones personalizados, podemos usar parabutton-theme estilizarlos. Puedes aprender más sobreigx-button el estilo en la documentación de Estilo de Botones. Podemos crear un tema personalizado para nuestroDone yCancel:

// custom.component.scss
...

$button-theme: button-theme(
  $palette: $purple-palette
);

...
.custom-buttons {
  @include css-vars($button-theme);
}

Ajustamos nuestra@include declaración.custom-buttons para que solo se aplique a losDone botones de andCancel.

Demo

Después de diseñar el banner y los botones, también definimos un estilo personalizado para la celda en modo de edición. El resultado de todos los estilos combinados se puede ver a continuación:

Note

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

Known Issues and Limitations

• Cuando la cuadrícula noprimaryKey tiene un sistema fijo y los escenarios de datos remotos están habilitados (al paginar, ordenar, filtrar o desplazar las solicitudes de disparo a un servidor remoto para recuperar los datos que se mostrarán en la cuadrícula), una fila perderá el siguiente estado tras completar una solicitud de datos:
  • Selección de fila
  • Fila Expandir/contraer
  • Edición de filas
  • Fijación de filas

API References

• filaEditable
• onRowEditEnter
• en fila
• filaEditarHecho
• onRowEditCancel
• fin
• campo
• editable
• Clave primaria
• Componente IgxTreeGrid

Additional Resources

• Cree operaciones CRUD con igxGrid
• Descripción general de la cuadrícula de árbol
• Edición de cuadrícula de árbol
• Tree Grid Transactions

Nuestra comunidad es activa y siempre da la bienvenida a nuevas ideas.

• Ignite UI for Angular Foros
• Ignite UI for Angular GitHub