Angular Tree Grid Remote Data Operations

O Ignite UI for Angular Tree Grid suporta operações remotas de dados, como virtualização remota, classificação remota, filtragem remota e outras. Isso permite que o desenvolvedor execute essas tarefas em um servidor, recupere os dados produzidos e os exiba na Grade de Árvore.

Angular Tree Grid Remote Data Operations Overview Example

Por padrão, a Grade de Árvore usa sua própria lógica para executar operações de dados. Você pode executar essas tarefas remotamente e alimentar os dados resultantes na Grade de Árvore aproveitando determinadas entradas e eventos, que são expostos pela Grade de Árvore.

Remote Filtering

Para fornecer filtragem remota, você precisa assinar a filteringExpressionsTreeChange saída para fazer a solicitação apropriada com base nos argumentos recebidos. Vamos usar uma coleção simples como fonte de dados para nossa Grade de Árvore, fornecendo a primaryKey e a foreignKey.

Também aproveitaremos a função rxjs debounceTime, que emite um valor da fonte Observable somente após um determinado intervalo de tempo ter passado sem outra emissão de origem. Dessa forma, a operação remota será acionada somente quando o tempo especificado tiver passado sem que o usuário a interrompa.

const DEBOUNCE_TIME = 300;
...
public ngAfterViewInit() {
    ...
    this.treeGrid.filteringExpressionsTreeChange.pipe(
        debounceTime(DEBOUNCE_TIME),
        takeUntil(this.destroy$)
    ).subscribe(() => {
        this.processData();
    });
}

Quando a filtragem remota é fornecida, geralmente não precisamos da filtragem interna da Grade de Árvore. Podemos desativá-lo definindo a filterStrategy entrada da Grade de Árvore para a NoopFilteringStrategy instância.

<!-- tree-grid-remote-filtering-sample.html -->

<igx-tree-grid #treeGrid [data]="remoteData | async" primaryKey="ID" foreignKey="ParentID"
               [autoGenerate]="false"
               [filterStrategy]="noopFilterStrategy"
               [allowFiltering]="true">
    <igx-column [field]="'Name'" dataType="string"></igx-column>
    <igx-column [field]="'Title'" dataType="string"></igx-column>
    <igx-column [field]="'Age'" dataType="number"></igx-column>
</igx-tree-grid>

// tree-grid-remote-filtering-sample.ts

public noopFilterStrategy = NoopFilteringStrategy.instance();

public processData() {
    this.treeGrid.isLoading = true;

    const filteringExpr = this.treeGrid.filteringExpressionsTree;

    this._remoteService.getData(filteringExpr, () => {
        this.treeGrid.isLoading = false;
    });
}

A filtragem remota terá que ser executada diretamente na coleção plana. Também teremos que incluir todos os pais para qualquer registro que corresponda à condição de filtragem, independentemente de os pais corresponderem ou não à filtragem (fazemos isso para manter a hierarquia intacta). O resultado pode ser visto abaixo:

Note

Quando dados remotos são solicitados, a operação de filtragem diferencia maiúsculas de minúsculas.

Remote Filtering Demo

Você pode ver o resultado do código acima no início deste artigo na seção Demonstração.

Unique Column Values Strategy

Os itens de lista dentro da caixa de diálogo Filtragem de Estilo do Excel representam os valores exclusivos para a respectiva coluna. A Grade de Árvore gera esses valores com base em sua fonte de dados por padrão. No caso de filtragem remota, os dados da grade não contêm todos os dados do servidor. Para fornecer os valores exclusivos manualmente e carregá-los sob demanda, podemos aproveitar a entrada do uniqueColumnValuesStrategy Tree Grid. Essa entrada é, na verdade, um método que fornece três argumentos:

• column: a respectiva instância da coluna.
• filteringExpressionsTree: a árvore de expressões de filtragem, que é reduzida com base na respectiva coluna.
• done- Retorno de chamada que deve ser chamado com os valores de coluna recém-gerados quando eles são recuperados do servidor.

O desenvolvedor pode gerar manualmente os valores de coluna exclusivos necessários com base nas informações, fornecidas pela coluna e pelos argumentos filteringExpressionsTree e, em seguida, invocar o retorno de chamada done.

Note

Quando a uniqueColumnValuesStrategy entrada é fornecida, o processo de geração de valores exclusivos padrão na filtragem de estilo do Excel não será usado.

<igx-tree-grid #treeGrid [data]="data" [filterMode]="'excelStyleFilter'" [uniqueColumnValuesStrategy]="columnValuesStrategy">
    ...
</igx-tree-grid>

public columnValuesStrategy = (column: ColumnType,
                               columnExprTree: IFilteringExpressionsTree,
                               done: (uniqueValues: any[]) => void) => {
    // Get specific column data.
    this.remoteValuesService.getColumnData(column, columnExprTree, uniqueValues => done(uniqueValues));
}

Unique Column Values Strategy Demo

Para fornecer um modelo de carregamento personalizado para a filtragem de estilo do Excel, podemos usar a igxExcelStyleLoading diretiva:

<igx-tree-grid [data]="data" [filterMode]="'excelStyleFilter'" [uniqueColumnValuesStrategy]="columnValuesStrategy">
    ...
    <ng-template igxExcelStyleLoading>
        Loading ...
    </ng-template>
</igx-tree-grid>

Remote Paging

Neste exemplo, demonstraremos como exibir um determinado número de registros raiz por página, independentemente de quantos registros filho eles tenham. Para cancelar o algoritmo de paginação de grade de árvore integrado, que exibe um certo número de registros, independentemente de seu nível (raiz ou filho), temos que definir a perPage propriedade como Number.MAX_SAFE_INTEGER.

<igx-tree-grid #treeGrid ...>
        <igx-paginator [perPage]="maxPerPage">
        </igx-paginator>
...

public maxPerPage = Number.MAX_SAFE_INTEGER;

Agora podemos escolher entre configurar nosso próprio modelo de paginação personalizado ou usar o padrão que o igx-paginator fornece. Primeiro, vamos dar uma olhada no que é necessário para configurar a paginação remota usando o modelo de paginação padrão.

Remote paging with default template

Se você quiser usar o modelo de paginação padrão, precisará definir a propriedade do totalRecords paginador, somente então a grade poderá calcular o número total da página com base no total de registros remotos. Ao executar uma paginação remota, o paginador passará para a grade apenas os dados da página atual, portanto, a grade não tentará paginar a fonte de dados fornecida. É por isso que devemos definir a propriedade de pagingMode Grid como GridPagingMode.remote. Também é necessário assinar pagingDone ou perPageChange eventos para buscar os dados do seu serviço remoto, depende do caso de uso qual evento será usado.

<igx-tree-grid #treeGrid [data]="data | async" childDataKey="Content" [pagingMode]="mode">
    <igx-column field="Name"></igx-column>
    ...
    <igx-paginator [(page)]="page" [(perPage)]="perPage" [totalRecords]="totalCount"
        (pagingDone)="paginate($event.current)">
    </igx-paginator>
</igx-tree-grid>

public totalCount = 0;
public data: Observable<any[]>;
public mode = GridPagingMode.remote;
public isLoading = true;
@ViewChild('grid1', { static: true }) public grid1: IgxGridComponent;

private _dataLengthSubscriber;

public set perPage(val: number) {
    this._perPage = val;
    this.paginate(0);
}

public ngOnInit() {
    this.data = this.remoteService.remoteData.asObservable();

    this._dataLengthSubscriber = this.remoteService.getDataLength().subscribe((data: any) => {
        this.totalCount = data;
        this.grid1.isLoading = false;
    });
}

public ngAfterViewInit() {
    const skip = this.page * this.perPage;
    this.remoteService.getData(skip, this.perPage);
}

public paginate(page: number) {
    this.page = page;
    const skip = this.page * this.perPage;
    const top = this.perPage;

    this.remoteService.getData(skip, top);
}

Remote Paging with custom igx-paginator-content

Quando definimos um conteúdo de paginador personalizado, precisamos definir o conteúdo de forma a obter os dados apenas para a página solicitada e passar os parâmetros skip e​ ​top corretos para o serviço remoto de acordo com a página e os itens selecionados perPage. Vamos usar o <igx-paginator> para facilitar nossa configuração de exemplo, junto com o e IgxPageNavigationComponent que foram introduzidos IgxPageSizeSelectorComponent-igx-page-size adicionará o menu suspenso e o rótulo por página e igx-page-nav adicionará os botões e rótulos de ação de navegação.

<igx-paginator #paginator
    [totalRecords]="totalCount"
    [(perPage)]="perPage"
    [selectOptions]="selectOptions"
    (pageChange)="paginate($event)">
    <igx-paginator-content>
        <igx-page-size></igx-page-size>
        [This is my custom content]
        <igx-page-nav></igx-page-nav>
    </igx-paginator-content>
</igx-paginator>

public paginate(page: number) {
    this.page = page;
    const skip = this.page * this.perPage;
    const top = this.perPage;

    this.remoteService.getData(skip, top);
}

Note

Para que a paginação remota seja configurada corretamente, um GridPagingMode.Remote deve ser definido:

<igx-tree-grid #treeGrid [data]="data | async" childDataKey="Content"
        expansionDepth="0" width="100%" height="540px" [pagingMode]="mode"></igx-tree-grid>
...
public mode = GridPagingMode.Remote;

A última etapa será declarar o conteúdo do paginador com base em seus requisitos.

<igx-paginator-content>
    <igx-page-size></igx-page-size>
    [This is my custom content]
    <igx-page-nav></igx-page-nav>
</igx-paginator-content>

Após todas as alterações acima, o seguinte resultado será alcançado.

Known Issues and Limitations

• Quando a grade não tiver nenhuma primaryKey configuração e os cenários de dados remotos estiverem habilitados (ao paginar, classificar, filtrar, rolar solicitações de gatilho para um servidor remoto para recuperar os dados a serem exibidos na grade), uma linha perderá o seguinte estado após a conclusão de uma solicitação de dados:
  • Seleção de linha
  • Expandir/recolher linha
  • Edição de linha
  • Fixação de linha
• Em cenários de dados remotos, quando a grade tiver um primaryKey argumento set,event rowSelectionChanging.oldSelection não conterá o objeto de dados de linha completa para as linhas que estão atualmente fora da exibição de dados. Nesse caso, rowSelectionChanging.oldSelection o objeto conterá apenas uma propriedade, que é o primaryKey campo. Para o restante das linhas, atualmente na exibição de dados, rowSelectionChanging.oldSelection conterá os dados da linha inteira.

API References

• IgxPaginatorComponent API
• IgxTreeGridComponent API
• IgxTreeGridComponent Styles

Additional Resources

• Paginação
• Visão geral da grade de árvore
• Virtualização e desempenho
• Filtragem
• Classificação
• Resumos
• Movimentação de Colunas
• Fixação de coluna
• Redimensionamento de colunas
• Escolha

Nossa comunidade é ativa e sempre acolhedora para novas ideias.

• Ignite UI for Angular Fóruns
• Ignite UI for Angular GitHub