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

    La persistencia de estado Ignite UI for Web Components en Web Components cuadrícula jerárquica permite a los desarrolladores guardar y restaurar fácilmente el estado de la cuadrícula. Cuando se IgcGridState aplica en el Web Components IgcHierarchicalGridComponent, expone los GetState​ ​GetStateAsString métodos y ApplyState​ ​ApplyStateFromString que los desarrolladores pueden usar para lograr la persistencia de estado en cualquier escenario.

    Funciones admitidas

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

    • RowIslands
      • guardar/restaurar funciones para todas las cuadrículas secundarias en la jerarquía
    • Clasificación
    • Filtración
    • AdvancedFiltering
    • Paginación
    • CellSelection
    • RowSelection
    • ColumnSelection
    • RowPinning
    • Expansión
    • Columns
      • Multi column headers
      • Orden de columnas
      • Column properties defined by the IColumnState interface.

    Uso

    El getState método devuelve el estado de la cuadrícula en un IgcGridStateInfo objeto, que contiene toda la información de estado. Es posible que se requieran pasos adicionales para guardarlo.

    Devuelve GetStateAsString una cadena JSON serializada, por lo que los desarrolladores pueden tomarla 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>
html
    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']);
typescript

    ApplyState- El método acepta un IgcGridStateInfo objeto como argumento y restaurará el estado de cada característica que se encuentre en el objeto o en las 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 que se encuentre en la cadena JSON o en las características especificadas como segundo argumento.

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

    El Options objeto implementa la IgcGridStateOptions interfaz, es decir, para cada clave, que es el nombre de una determinada característica, existe el valor booleano que indica si se realizará un seguimiento del estado de esta característica. GetState / GetStateAsString methods no colocará el estado de estas características en el valor devuelto y ApplyState / ApplyStateFromString methods no restaurará el estado de las mismas.

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

    Las API de punto único fáciles de usar permiten lograr una funcionalidad de persistencia de estado completa en solo unas pocas líneas de código. Copie y pegue el código desde abajo: guardará el estado de la cuadrícula en el objeto del navegador LocalStorage cada vez que el usuario abandone la página actual. Cada vez que el usuario regrese a la página principal, se restaurará el estado de la cuadrícula. Ya no es necesario configurar esas complejas expresiones avanzadas de filtrado y ordenación cada vez para obtener los datos que desea: hágalo una vez y haga que el código de abajo haga el resto por sus 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);
    }
}
typescript
    Ignite UI for Web Components | CTA Banner

    Restaurar redes secundarias

    El estado de guardado/restauración de las cuadrículas secundarias está controlado por la RowIslands propiedad y está habilitado de forma predeterminada. IgcGridState utilizará las mismas opciones para guardar/restaurar características tanto para la cuadrícula raíz como para todas las cuadrículas secundarias de la jerarquía. Por ejemplo, si pasamos las siguientes opciones:

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

    A continuación, la getState API devolverá el estado de todas las funciones de las cuadrículas (cuadrícula raíz y cuadrículas secundarias) excluyendo Selection y Sorting. Si más adelante el desarrollador desea restaurar solo el Filtering estado de todas las cuadrículas, use:

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

    Manifestación

    EXAMPLE
    TS
    HTML
    CSS
    Edit in:

    ¿Te gusta esta muestra? Obtenga acceso a nuestro kit de herramientas de Ignite UI for Web Components completo y comience a crear sus propias aplicaciones en minutos. Descárgalo gratis.

    Limitaciones

    • Al restaurar todas las características de la cuadrícula a la vez (mediante applyState una API sin parámetros), es posible que las propiedades de columna de la cuadrícula raíz se restablezcan a los valores predeterminados. Si esto sucede, restaure las columnas 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);
typescript