Web Components Persistencia del estado de la cuadrícula jerárquica

The Ignite UI for Web Components State Persistence in Web Components Hierarchical Grid allows developers to easily save and restore the grid state. When the IgcGridStateComponent is applied on the Web Components IgcHierarchicalGridComponent, it exposes the getState, getStateAsString, applyState and applyStateFromString methods that developers can use to achieve state persistence in any scenario.

Supported Features

IgcGridStateComponentSoporta guardar y restaurar el estado de las siguientes características:

• RowIslands
  • guardar/restaurar funciones para todas las cuadrículas secundarias en la jerarquía
• Sorting
• Filtering
• AdvancedFiltering
• Paginación
• CellSelection
• RowSelection
• ColumnSelection
• RowPinning
• Expansión
• Columns
  • Multi column headers
  • Orden de columnas
  • Propiedades de columna definidas por laIColumnState interfaz.

Usage

ElgetState método devuelve el estado de la cuadrícula en unIgcGridStateInfo objeto, que contiene toda la información del estado. Puede que se requieran pasos adicionales para salvarlo.

DevuelvegetStateAsString una cadena JSON serializada, así que los desarrolladores pueden simplemente usarla y guardarla en cualquier almacenamiento de datos (base de datos, nube, navegador localStorage, etc.).

El desarrollador puede optar por obtener solo el estado de una determinada característica o características, pasando una matriz con nombres de características como argumento. La matriz vacía dará como resultado el uso de las opciones de estado predeterminadas.

<igc-hierarchical-grid id="grid">
    <igc-grid-state id="gridState"></igc-grid-state>
</igc-hierarchical-grid>

var gridState = document.getElementById('gridState') as IgcGridStateComponent;

// get an `IgcGridStateInfo` object, containing all features original state objects, as returned by the grid public API
const state: IgcGridStateInfo = gridState.getState();

// get all features` state in a serialized JSON string
const stateString: string = gridState.getStateAsString();

// get the sorting and filtering expressions
const sortingFilteringStates: IgcGridStateInfo = gridState.getState(['sorting', 'filtering']);

applyState- El método acepta unIgcGridStateInfo objeto como argumento y restaurará el estado de cada característica encontrada en el objeto o características especificadas como segundo argumento.

applyStateFromString- El método acepta una cadena JSON serializada como argumento y restaurará el estado de cada característica encontrada en la cadena JSON o características especificadas como segundo argumento.

gridState.applyState(gridState);
gridState.applyStateFromString(gridStateString);
gridState.applyState(sortingFilteringStates)

Eloptions objeto implementa laIgcGridStateOptions interfaz, es decir, para cada clave, que es el nombre de una determinada característica, existe el valor booleano que indica si este estado de la característica será rastreado.getState /getStateAsString methods no pondrá el estado de estas características en el valor devuelto yapplyState /applyStateFromString methods no restaurará el estado para ellas.

gridState.options = { cellSelection: false, sorting: false };

Las APIs de punto único, sencillas de usar, permiten lograr una funcionalidad de persistencia completa de estado en solo unas pocas líneas de código. Copia y pega el código de abajo: guardará el estado de la cuadrícula en el objeto del navegadorLocalStorage cada vez que el usuario salga de la página actual. Cada vez que el usuario regresa a la página principal, el estado de la cuadrícula se restaurará. Ya no hace falta configurar esos complejos filtrados avanzados y ordenar expresiones cada vez para obtener los datos que quieres: hazlo una vez y el código de abajo hace el resto por tus usuarios:

constructor() {
    window.addEventListener("load", () => { this.restoreGridState(); });
    window.addEventListener("beforeunload", () => { this.saveGridState(); });
}

// Using methods that work with IgcGridStateInfo object.
public saveGridState() {
    const state = this.gridState.getState();
    window.localStorage.setItem('grid-state', JSON.stringify(state));
}

public restoreGridState() {
    const state = window.localStorage.getItem('grid-state');
    if (state) {
        this.gridState.applyState(JSON.parse(state));
    }
}

// Or using string alternative methods.
public saveGridStateString() {
    const state = this.gridState.getStateAsString();
    window.localStorage.setItem('grid-state', state);
}

public restoreGridStateString() {
    const state = window.localStorage.getItem('grid-state');
    if (state) {
        this.gridState.applyStateFromString(state);
    }
}

Restoring Child Grids

El guardado/restauración del estado para las cuadrículas hijas está controlado por laRowIslands propiedad y está habilitado por defecto.IgcGridStateComponent Utilizaré las mismas opciones para guardar/restaurar características tanto para la cuadrícula raíz como para todas las cuadrículas hijas de la jerarquía. Por ejemplo, si pasamos las siguientes opciones:

gridState.options = { cellSelection: false, sorting: false, rowIslands: true };

Luego lagetState API devolverá el estado de todas las cuadrículas (cuadrícula raíz y cuadrículas hijas), exceptoSelection ySorting. Si más adelante el promotor quiere restaurar solo elFiltering estado de todas las cuadras, usa:

this.state.applyState(state, ['filtering', 'rowIslands']);

Demo

Limitations

• Al restaurar todas las características de la cuadrícula a la vez (usandoapplyState una API sin parámetros), las propiedades de columna para la cuadrícula raíz pueden restablecerse a valores predeterminados. Si esto ocurre, restaura la columna o la función de selección de columnas por separado después de eso:

state.applyState(gridState);
state.applyState(gridState.columns);
state.applyState(gridState.columnSelection);

• getStateAsStringel método utiliza JSON.stringify() para convertir los objetos originales en una cadena JSON. JSON.stringify() no soporta Functions, por eso elIgcGridStateComponent Component ignorará las columnasformatter,filters,Summaries,SortStrategy,CellClasses,CellStyles,HeaderTemplate yBodyTemplate Propiedades.