Edición de celdas en cuadrícula Angular

    Ignite UI for Angular componente Grid proporciona una gran capacidad de manipulación de datos y una potente API para Angular operaciones CRUD. De forma predeterminada, la cuadrícula 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 las acciones de actualización de datos y para invalidar el comportamiento predeterminado para confirmar y descartar cualquier cambio.

    Angular Grid cell editing and edit templates Example

    Note

    Al usarloigxCellEditor con cualquier tipo de componente del editor, el flujo de navegación del teclado se verá interrumpido. Lo mismo ocurre con la edición directa de la celda personalizada que entra en modo de edición. Esto se debe a quefocus permanecerán en elcell element, no en el componente editor que hemos añadido -igxSelect,igxCombo, etc. Por eso deberíamos aprovechar laigxFocus directiva, que moverá el foco directamente al componente dentro de la celda y preservaráa fluent editing flow 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;
    • al pulsarEnter teclas;
    • al pulsarF2 teclas;

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

    • al pulsarEscape teclas;
    • 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:

    • al pulsarEnter teclas;
    • al pulsarF2 teclas;
    • al pulsarTab teclas;
    • con un solo clic en otra celda: cuando haga clic en otra celda de la cuadrícula, 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. 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 IgxGrid, pero solo si está definida la clave principal:

    public updateCell() {
        this.grid1.updateCell(newValue, rowID, 'ReorderLevel');
    }
    

    Otra forma de actualizar celdas es directamente medianteupdate el método de:IgxGridCell

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

    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 quieres proporcionar una plantilla personalizada que se aplique cuando una celda esté en modo edición, puedes usar laigxCellEditor directiva. Para ello, necesitas pasar unang-template marca con laigxCellEditor directiva y vincular correctamente tu control personalizado a: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 ejemplo siguiente, que implementa unIgxSelectComponent en las celdas de lasRace columnas yClass.Alignment

    Note

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

    Note

    La plantillaigxCell de celdas controla cómo se muestran las celdas de una columna cuando está fuera del modo edición. La directivaigxCellEditor de plantilla de edición de celdas gestiona 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

    Al usarloigxCellEditor con cualquier tipo de componente del editor, el flujo de navegación del teclado se verá interrumpido. Lo mismo ocurre con la edición directa de la celda personalizada que entra en modo de edición. Esto se debe a quefocus permanecerán en elcell element, no en el componente editor que hemos añadido -igxSelect,igxCombo, etc. Por eso deberíamos aprovechar laigxFocus directiva, que moverá el foco directamente al componente dentro de la celda y preservaráa fluent editing flow la celda/fila.

    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.

    Grid Excel Style Editing

    El uso de la edición de estilo de Excel permite al usuario navegar a través de las celdas tal como lo haría con Excel y editarlas muy rápidamente.

    La implementación de esta funcionalidad personalizada se puede realizar utilizando los eventos de la cuadrícula. Primero nos conectamos a los eventos de keydown del grid y desde allí podemos implementar dos funcionalidades:

    • Modo de edición constante
    public keydownHandler(event) {
      const key = event.keyCode;
      const grid = this.grid;
      const activeElem = grid.navigation.activeNode;
    
      if(
        (key >= 48 && key <= 57) ||
        (key >= 65 && key <= 90) ||
        (key >= 97 && key <= 122)){
            // Number or Alphabet upper case or Alphabet lower case
            const columnName = grid.getColumnByVisibleIndex(activeElem.column).field;
            const cell = grid.getCellByColumn(activeElem.row, columnName);
            if (cell && !cell.editMode) {
                cell.editMode = true;
                cell.editValue = event.key;
                this.shouldAppendValue = true;
            } else if (cell && cell.editMode && this.shouldAppendValue) {
                event.preventDefault();
                cell.editValue = cell.editValue + event.key;
                this.shouldAppendValue = false;
            }
        }
    }
    
    • Enter/ Shift+Enter navigation
    if (key == 13) {
        let thisRow = activeElem.row;
        const column = activeElem.column;
        const rowInfo = grid.dataView;
    
        // to find the next eiligible cell, we will use a custom method that will check the next suitable index
        let nextRow = this.getNextEditableRowIndex(thisRow, rowInfo, event.shiftKey);
    
        // and then we will navigate to it using the grid's built in method navigateTo
        this.grid.navigateTo(nextRow, column, (obj) => {
            obj.target.activate();
            this.grid.clearCellSelection();
            this.cdr.detectChanges();
        });
    }
    

    Las partes clave para encontrar el próximo índice elegible serían:

    //first we check if the currently selected cell is the first or the last
    if (currentRowIndex < 0 || (currentRowIndex === 0 && previous) || (currentRowIndex >= dataView.length - 1 && !previous)) {
    return currentRowIndex;
    }
    // in case using shift + enter combination, we look for the first suitable cell going up the field
    if(previous){
    return  dataView.findLastIndex((rec, index) => index < currentRowIndex && this.isEditableDataRecordAtIndex(index, dataView));
    }
    // or for the next one down the field
    return dataView.findIndex((rec, index) => index > currentRowIndex && this.isEditableDataRecordAtIndex(index, dataView));
    

    Consulte la muestra completa para obtener más referencias:

    Angular Grid Excel Style Editing Sample

    Los principales beneficios del enfoque anterior incluyen:

    • Modo de edición constante: al escribir mientras se selecciona una celda, se ingresará inmediatamente al modo de edición con el valor ingresado, reemplazando el existente
    • Any non-data rows are skipped when navigating with Enter/Shift+Enter. This allows users to quickly cycle through their values.

    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.

    ProporcionaIgxGridComponent una API sencilla para operaciones básicas de CRUD.

    Adding a new record

    The Grid component exposes the addRow method which will add the provided data to the data source itself.

    // Adding a new record
    // Assuming we have a `getNewRecord` method returning the new row data.
    const record = this.getNewRecord();
    this.grid.addRow(record);
    

    Updating data in the Grid

    Updating data in the Grid is achieved through updateRow and updateCell methods but only if primary key for the grid is defined. You can also directly update a cell and/or a row value through their respective update methods.

    // Updating the whole row
    this.grid.updateRow(newData, this.selectedCell.cellID.rowID);
    
    // Just a particular cell through the Grid API
    this.grid.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.grid.getRowByKey(rowID);
    row.update(newData);
    

    Deleting data from the Grid

    Ten en cuenta que esedeleteRow() método eliminará la fila especificada solo si la clave primaria está definida.

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

    Estos pueden estar conectados a interacciones del usuario, no necesariamente relacionadas con igx-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 modificar cómo el usuario interactúa con la cuadrícula. En este ejemplo, validaremos una celda basándonos en los datos introducidos en ella al vincularse alcellEdit evento. Si el nuevo valor de la celda no cumple 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 usandoIgxToast.

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

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

    SecellEdit emite cuando el valor de cualquier célula está a punto de comprometerse. En nuestrahandleCellEdit definición, debemos asegurarnos de comprobar nuestra columna específica antes de tomar cualquier acción:

    export class MyGridEventsComponent {
        public handleCellEdit(event: IGridEditEventArgs): void {
            const column = event.column;
            if (column.field === 'Ordered') {
                const rowData = event.rowData;
                if (!rowData) {
                    return;
                }
                if (event.newValue > rowData.UnitsInStock) {
                    event.cancel = true;
                    this.toast.open();
                }
            }
        }
    }
    

    Si el valor ingresado en una celda bajo la columna Pedido es mayor que la cantidad disponible (el valor bajo Unidades en stock), la edición se cancelará y se mostrará un brindis con un mensaje de error.

    El resultado de la validación anterior aplicada a nuestroigx-grid puede verse en la siguiente demostración:

    Estilismo

    The IgxGrid allows for its cells to be styled through the Ignite UI for Angular Theme Library. The grid's grid-theme exposes a wide range of properties, which allow users to style many different aspects of the grid.

    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 poder usar elIgnite UI Theming Library, primero debemos importar el archivo de temaindex 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 el motor de temas Ignite UI for Angular.

    Defining a palette

    Después de importar correctamente el archivo de índice, creamos una paleta personalizada que podemos usar. Definamos tres colores que nos gustan y usemos para crear una paleta conpalette:

    $white: #fff;
    $blue: #4567bb;
    $gray: #efefef;
    
    $color-palette: palette(
      $primary: $white, 
      $secondary: $blue, 
      $surface: $gray
    );
    

    Defining themes

    We can now define the theme using our palette. The cells are styled by the grid-theme, so we can use that to generate a theme for our IgxGrid:

    $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 unasass @include instrucción en el archivo de estilos globales:

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

    Demo

    Además de los pasos anteriores, también podemos estilizar los controles que se usan para las plantillas de edición de las celdas:input-group,datepicker &checkbox

    Note

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

    API References

    Additional Resources