Blazor Persistência de estado de grade hierárquica

    A persistência de estado Ignite UI for Blazor em Blazor grade hierárquica permite que os desenvolvedores salvem e restaurem facilmente o estado da grade. Quando o IgbGridState é aplicado no Blazor IgbHierarchicalGrid, ele expõe os métodos e ApplyStateFromStringAsync que os GetStateAsStringAsync desenvolvedores podem usar para obter persistência de estado em qualquer cenário.

    Supported Features

    IgbGridState dá suporte ao salvamento e à restauração do estado dos seguintes recursos:

    • RowIslands
      • Salvando/restaurando recursos para todas as grades filhas na hierarquia
    • Sorting
    • Filtering
    • AdvancedFiltering
    • Paginação
    • CellSelection
    • Seleção de linha
    • ColumnSelection
    • RowPinning
    • Expansão
    • Columns
      • Multi column headers
      • Ordem das colunas
      • Column properties defined by the IColumnState interface.

    Usage

    O GetStateAsStringAsync retorna uma string JSON serializada, para que os desenvolvedores possam simplesmente pegá-la e salvá-la em qualquer armazenamento de dados (banco de dados, nuvem, navegador localStorage, etc.).

    O desenvolvedor pode optar por obter apenas o estado de um determinado recurso/recursos, passando uma matriz com nomes de recursos como argumento. A matriz vazia resultará no uso das opções de estado padrão.

    <IgbHierarchicalGrid>
    <IgbGridState @ref="gridState"></IgbGridState>
</IgbHierarchicalGrid>

@code {
    // get all features` state in a serialized JSON string
    string stateString = gridState.GetStateAsStringAsync(new string[0]);

    // get the sorting and filtering expressions
    string sortingFilteringStates = gridState.GetStateAsStringAsync(new string[] { "sorting", "filtering" });
}

    ApplyStateFromStringAsync- O método aceita uma string JSON serializada como argumento e restaurará o estado de cada recurso encontrado na string JSON ou recursos especificados como segundo argumento.

    gridState.ApplyStateFromStringAsync(gridStateString, new string[0]);
gridState.ApplyStateFromStringAsync(sortingFilteringStates, new string[0])

    O Options objeto implementa a IgbGridStateOptions interface, ou seja, para cada chave, que é o nome de uma determinada característica, há o valor booleano indicando se esse estado de característica será rastreado. GetStateAsStringAsync Os métodos não colocarão o estado desses recursos no valor retornado e ApplyStateFromStringAsync os métodos não restaurarão o estado deles.

    gridState.Options = new IgbGridStateOptions
    {
        CellSelection = false,
        Sorting = false
    };

    As APIs de ponto único simples de usar permitem obter uma funcionalidade completa de persistência de estado em apenas algumas linhas de código. Copie e cole o código abaixo- ele salvará o estado da grade no objeto do navegador LocalStorage toda vez que o usuário sair da página atual. Sempre que o usuário retornar à página principal, o estado da grade será restaurado. Não há mais necessidade de configurar essas expressões complexas de filtragem e classificação avançadas todas as vezes para obter os dados desejados - faça isso uma vez e faça com que o código abaixo faça o resto para seus usuários:

    @using IgniteUI.Blazor.Controls
@using Newtonsoft.Json
@implements IDisposable

@inject IJSRuntime JS
@inject NavigationManager Navigation

<IgbHierarchicalGrid Rendered="OnGridRendered">
    <IgbGridState @ref="gridState"></IgbGridState>
    <IgbColumn Field="ContactName" Header="Name" MinWidth="200px" ></IgbColumn>
    <IgbColumn Field="ContactTitle" Header="Title" MinWidth="200px" Sortable="true" Filterable="true" Groupable="true"></IgbColumn>
    <IgbColumn Field="CompanyName" Header="Company" MinWidth="200px" Sortable="true" Filterable="true" Groupable="true"></IgbColumn>
</IgbHierarchicalGrid>

@code {
    protected override void OnAfterRender(bool firstRender)
    {
        Navigation.LocationChanged += OnLocationChanged;
    }

    void OnLocationChanged(object sender, LocationChangedEventArgs e)
    {
        SaveGridState();
    }

    void IDisposable.Dispose()
    {
        // Unsubscribe from the event when our component is disposed
        Navigation.LocationChanged -= OnLocationChanged;
    }

    void OnGridRendered()
    {
        RestoreGridState();
    }

    async void SaveGridState() {
        string state = gridState.GetStateAsStringAsync(new string[0]);
        await JS.InvokeVoidAsync("window.localStorage.setItem", "grid-state", state);
    }

    async void RestoreGridState() {
        string state = await JS.InvokeAsync<string>("window.localStorage.getItem", "grid-state");
        if (state) {
            gridState.ApplyStateFromStringAsync(state, new string[0]);
        }
    }
}

    Restoring Child Grids

    Salvar/restaurar o estado das grades filho é controlado pela RowIslands propriedade e é habilitado por padrão. IgbGridState usará as mesmas opções para salvar/restaurar recursos tanto para a grade raiz quanto para todas as grades filhas na hierarquia. Por exemplo, se passarmos as seguintes opções:

    <IgbHierarchicalGrid>
    <IgbGridState @ref="gridState"></IgbGridState>
</IgbHierarchicalGrid>

@code {
    private IgbGridState gridState;

    gridState.Options = new IgbGridStateOptions
    {
        CellSelection = false,
        Sorting = false,
        RowIslands = true
    };
}

    Em seguida, a GetState API retornará o estado de todos os recursos de grades (grade raiz e grades filhas), excluindo Selection e Sorting. Se, posteriormente, o desenvolvedor quiser restaurar apenas o Filtering estado de todas as grades, use:

    gridState.ApplyStateFromStringAsync(gridStateString, new string[] { "filtering", "rowIslands" });

    Demo

    Limitations

    • Ao restaurar todos os recursos de grade de uma só vez (usando applyState API sem parâmetros), as propriedades da coluna para a grade raiz podem ser redefinidas para o padrão. Se isso acontecer, restaure as colunas ou o recurso de seleção de coluna separadamente depois disso: