Edición de celdas de cuadrícula de árbol Web Components

    La Ignite UI for Web Components en Web Components Tree Grid proporciona una excelente capacidad de manipulación de datos del contenido de celdas individuales dentro del componente Web Components Tree Grid y viene con una potente API para operaciones React CRUD. Es una característica fundamental en aplicaciones como hojas de cálculo, tablas de datos y cuadrículas de datos, que permite a los usuarios agregar, editar o actualizar datos dentro de celdas específicas. De forma predeterminada, la cuadrícula en Ignite UI for Web Components se utiliza en la edición de celdas. Y debido a la plantilla de edición de celda predeterminada, habrá diferentes editores según el tipo de datos de la columna Parte superior del formulario.

    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.

    Web Components Tree Grid Cell Editing and Edit Templates Example

    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 hace clic en otra celda en IgcTreeGridComponent, 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] The cell remains in edit mode when you scroll vertically or horizontally or click outside the IgcTreeGridComponent. This is valid for both cell editing and row editing.

    Editing through API

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

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

    Otra forma de actualizar la celda es directamente a través del Update método de Cell:

    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á a una celda, puede pasar dicha plantilla a la celda misma o a su encabezado. Primero cree la columna como lo haría normalmente:

    <igc-column
        field="Category"
        data-type="string"
        editable="true"
        id="column1">
    </igc-column>
    

    y pase las plantillas a esta columna en el archivo index.ts:

    
    constructor() {
        var treeGrid = document.getElementById('treeGrid') as IgcTreeGridComponent;
        var column1 = document.getElementById('column1') as IgcColumnComponent;
    
        treeGrid.data = this.webGridCellEditSampleRoleplay;
        column1.inlineEditorTemplate = this.webGridCellEditCellTemplate;
        column2.inlineEditorTemplate = this.webGridCellEditCellTemplate;
        column3.inlineEditorTemplate = this.webGridCellEditCellTemplate;
    }
    
    public webGridCellEditCellTemplate = (ctx: IgcCellTemplateContext) => {
        let cellValues: any = [];
        let uniqueValues: any = [];
        for(const i of (this.webGridCellEditSampleRoleplay as any)){
            const field: string = ctx.cell.column.field;
            if(uniqueValues.indexOf(i[field]) === -1 )
            {
                cellValues.push(html`<igc-select-item value=${i[field]}>${(i[field])}</igc-select-item>`);
                uniqueValues.push(i[field]);
            }
        }
        return html`
        <igc-select style="width:100%; height:100%" size="large" @igcChange=${(e: any) => ctx.cell.editValue = e.detail.value}>
                ${cellValues}
        </igc-select>
        `;
    }
    

    Puede encontrar una muestra funcional de lo anterior aquí para mayor referencia:

    CRUD operations

    [!Note] Please keep in mind that when you perform some CRUD operation all of the applied pipes like filtering, sorting and grouping will be re-applied and your view will be automatically updated.

    The IgcTreeGridComponent provides a straightforward API for basic CRUD operations.

    Adding a new record

    El componente IgcTreeGridComponent 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 primaria para la cuadrícula. También puede actualizar directamente un valor de celda y/o fila a través de sus respectivos métodos de actualización.

    // 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 una primaryKey.

    // 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();
    

    Cell Validation on Edit Event

    Usando los eventos de edición de IgcTreeGridComponent, podemos alterar la forma en que el usuario interactúa con IgcTreeGridComponent.

    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.

    Lo primero que tenemos que hacer es enlazar al evento de la cuadrícula:

    constructor() {
        var treeGrid = document.getElementById('treeGrid') as IgcTreeGridComponent;
        this.webTreeGridCellEdit = this.webTreeGridCellEdit.bind(this);
        treeGrid.addEventListener("cellEdit", this.webTreeGridCellEdit);
    }
    

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

    public webTreeGridCellEdit(event: CustomEvent<IgcGridEditEventArgs>): void {
        const column = event.detail.column;
        		
        if (column.field === 'Age') {
            if (event.detail.newValue < 18) {
                event.detail.cancel = true;
                alert('Employees must be at least 18 years old!');
            }
        } else if (column.field === 'HireDate') {
            if (event.detail.newValue > new Date().getTime()) {
                event.detail.cancel = true;
                alert('The employee hire date must be in the past!');
            }
        }
    }
    
    

    Si el valor introducido en una celda de la columna Edad es inferior a 18 años o el valor de la columna HireDate está en el futuro, la edición se cancelará y el usuario recibirá una alerta de la cancelación.

    El resultado de la validación anterior aplicada a nuestro IgcTreeGridComponent se puede ver en la siguiente demostración:

    Styling

    Además de los temas predefinidos, la cuadrícula se puede personalizar aún más configurando algunas de las propiedades CSS disponibles. En caso de que desee cambiar algunos de los colores, primero debe establecer una clase para la cuadrícula:

    <igc-tree-grid class="treeGrid"></igc-tree-grid>
    

    Luego configure las propiedades CSS relacionadas para esa clase:

    .treeGrid {
        --ig-grid-edit-mode-color: orange;
        --ig-grid-cell-editing-background: lightblue;
    }
    

    Styling Example

    API References

    Additional Resources