Paginação Remota da Grid
Paginação remota é uma funcionalidade que permite que a grid carregue e exiba dados dinamicamente, buscando apenas uma porção dos dados do servidor conforme necessário. Isso resulta em desempenho aprimorado, particularmente para grandes conjuntos de dados, evitando a necessidade de buscar todos os registros de uma vez.
Principais Benefícios da Paginação Remota
- Desempenho aprimorado: Carrega apenas os dados necessários, reduzindo tempos de carregamento.
- Escalável: Lida com grandes conjuntos de dados com eficiência.
- Controle do usuário: Oferece flexibilidade aos desenvolvedores e usuários em como os dados são apresentados.
Como a Paginação Remota Funciona
Paginação remota divide os dados em “páginas” que são solicitadas individualmente de um servidor remoto. Isso garante que apenas a fatia de dados necessária seja carregada por vez. Pode ser configurada para componentes Grid e Tree Grid usando propriedades integradas na ferramenta.
Os usuários usam um Configurador para configurar tudo o que é necessário para a paginação remota funcionar. O que é necessário?
pageIndex- O índice da página cujos dados serão buscados. Se este parâmetro não for fornecido, o índice da página padrão será 0, que busca a primeira página de dados.pageSize- O número máximo de registros a buscar e exibir por página. Se este parâmetro não for fornecido, todos os registros serão buscados e o número total de páginas será 1.totalRecords- Retorna o número total de registros disponíveis no servidor. Este número é necessário para o Paginador calcular o número total de páginas.
Fluxo do usuário:
Fluxo do usuário do Configurador
Configuração do Usuário
Paginação remota pode ser implementada por desenvolvedores seguindo duas abordagens, dependendo de como a API lida com dados e contagem de registros totais.
-
Usando um Endpoint Combinado para Dados e Contagem Total de Registros
Neste caso, a API retorna tanto os dados paginados quanto o número total de registros em uma única resposta. -
Usando Endpoints Separados para Dados e Contagem Total de Registros
Nesta configuração, duas chamadas de API são feitas: uma para recuperar os dados paginados e outra para obter a contagem de registros totais.
Endpoint único
Este é um exemplo de estrutura de dados suportada:
{
"items": [
{
"categoryId": 0,
"description": "string",
"name": "string"
}
],
"totalRecordsCount": 0,
"pageSize": 0,
"pageNumber": 0,
"totalPages": 0
}
Etapas:
- Conecte a Grid a um endpoint que retorne um Object com coleção de Items e campo Total Records Count. Object que fornece uma coleção de itens e a Contagem de Registros Totais.
- Adicione recurso de paginação remota e selecione o modo de paginação Remoto para carregar o diálogo Configuration.
- Através do Diálogo de Configuração de Paginação, selecione a propriedade de campo que corresponde à Contagem de Registros Totais. No exemplo acima, seria “totalRecordsCount”.
- Através do Diálogo de Configuração de Paginação, especifique o parâmetro de query que será usado para Page Index e o usado para Page Size.
- Clique em Save
Resultado:
- Duas variáveis do tipo number para armazenar os valores de Page Index e Page Size são criadas.
- Terceira variável para armazenamento do contexto de dados da Grid será criada. Tipo Object, inicializada a partir da solicitação de dados. Os parâmetros Query da solicitação serão vinculados às variáveis Page index e Page size.
- A Grid será vinculada à coleção result.items do resultado do contexto de dados da terceira variável.
- Contagem de registros totais será vinculada ao campo result.totalRecordsCount.
- Duas interações para PerPageChanged e PageChange serão criadas automaticamente.
- PerPageChange terá Source (value) definido como Page size proveniente do contexto de Event fornecido pelo igx-paginator. A variável Target será Page Size.
- PageChange terá Source (value) definido como Page index (página atual) proveniente do contexto de Event fornecido pelo igx-paginator. A variável Target será Page Index.
Comportamento: On Preview, o carregamento inicial realizará apenas uma solicitação. Após mudança de página ou alteração de valor por página, uma nova solicitação será feita para buscar os dados com base nos novos valores de Page e Size.
Dois endpoints diferentes
Etapas:
- Vincule a propriedade
Datada grid a um endpoint que espera parâmetros de query Page e Size. - Adicione recurso de paginação remota e selecione o modo de paginação Remoto para carregar o diálogo Configuration.
- Conecte o totalRecordsCount a um endpoint diferente (diferente da propriedade
Datada grid) que retorna apenas a contagem de registros totais. - Através do Diálogo de Configuração de Paginação, especifique o parâmetro de query que será usado para Page Index e o usado para Page Size.
- Clique em Save
Resultado:
- Duas variáveis do tipo number para armazenar os valores de Page Index e Page Size são criadas.
- Fonte de dados da Grid terá parâmetros de query vinculados às duas variáveis recém-criadas.
- Terceira variável para armazenamento da Contagem de registros totais será criada. Tipo Object, inicializada a partir da solicitação de dados. (Observe que, atualmente, AB não suporta tipos de resultado primitivos)
- Duas interações para PerPageChanged e PageChange serão criadas automaticamente.
- PerPageChange terá Source (value) definido como Page size proveniente do contexto de Event fornecido pelo igx-paginator. A variável Target será Page Size.
- PageChange terá Source (value) definido como Page index (página atual) proveniente do contexto de Event fornecido pelo igx-paginator. A variável Target será Page Index.
Comportamento:
- Ao ir para Preview, o carregamento inicial realizará duas solicitações, uma para os dados de slice da grid e outra para a contagem de registros totais. Depois disso, após mudança de página ou mudança por página, apenas uma solicitação será feita para os dados de slice da Grid.
Limitações Conhecidas
Quando o usuário configura paginação remota com o configurador e o executa novamente, a variável redundante, que é inicializada a partir do endpoint da API, continuará existindo.
