Filtragem de dados de runtime para painéis e elementos visuais incorporados do QuickSight - Amazon QuickSight
Terminologia e conceitosConfiguraçãoInterface para métodos do SDK

Filtragem de dados de runtime para painéis e elementos visuais incorporados do QuickSight

É possível usar os métodos de filtragem no SDK de incorporação do Amazon QuickSight para aproveitar os recursos avançados dos filtros do QuickSight na aplicação de software como serviço (SaaS) durante o runtime. Os filtros de runtime permitem que os proprietários de negócios integrem a aplicação com os painéis e com os elementos visuais incorporados do QuickSight. Para isso, crie controles de filtro personalizados na aplicação e aplique definições prévias de filtros com base nos dados da aplicação. Assim, os desenvolvedores poderão ajustar as configurações de filtro para os usuários finais durante o runtime.

Os desenvolvedores podem criar, consultar, atualizar e remover filtros em um painel ou em um elemento visual incorporado diretamente da aplicação com o SDK de incorporação do QuickSight. Crie objetos de filtro do QuickSight na aplicação com o modelo de dados FilterGroup e aplique-os a painéis e elementos visuais incorporados usando os métodos de filtragem. Para obter mais informações sobre como usar o SDK de incorporação do QuickSight, consulte amazon-quicksight-embedding-sdk no GitHub.

Pré-requisitos

Antes de começar a usar, certifique-se de estar empregando o SDK de incorporação do QuickSight na versão 2.5.0 ou em versões superiores.

Terminologia e conceitos

A terminologia apresentada a seguir pode ser útil ao trabalhar com a filtragem de runtime incorporada.

  • Grupo de filtros: um conjunto de filtros individuais. Os filtros localizados dentro de um FilterGroup são combinados com a lógica OR entre si. Os filtros dentro de um FilterGroup são aplicados às mesmas planilhas ou aos mesmos elementos visuais.

  • Filtro: um único filtro. O filtro pode ser um tipo de filtro de categoria, numérico ou de data e hora. Para obter mais informações sobre os filtros, consulte Filter.

Configuração

Antes de começar, certifique-se de ter os recursos e as informações apresentados a seguir preparados.

  • O ID da planilha da planilha que você deseja delimitar para o FilterGroup. Esse ID pode ser obtido com o método getSheets no SDK de incorporação.

  • O identificador do conjunto de dados e da coluna do conjunto de dados que você deseja filtrar. Esses dados podem ser obtidos por meio da operação DescribeDashboardDefinition da API.

    Dependendo do tipo de coluna que você usa, pode haver restrições sobre os tipos de filtros que podem ser adicionados a um ativo incorporado. Para obter mais informações sobre as restrições de filtro, consulte Filter.

  • O ID do elemento visual ao qual você deseja delimitar o FilterGroup, se aplicável. Esse ID pode ser obtido ao usar o método getSheetVisuals no SDK de incorporação.

    Além do método getSheetVisuals, o FilterGroup que você adicionar pode ser delimitado somente à planilha selecionada no momento.

Para usar esse recurso, você já deve ter um painel ou um elemento visual incorporado à aplicação por meio do SDK de incorporação do QuickSight. Para obter mais informações sobre como usar o SDK de incorporação do QuickSight, consulte amazon-quicksight-embedding-sdk no GitHub.

Interface para métodos do SDK

Métodos “getter” para incorporação de painéis

A tabela apresentada a seguir descreve os diferentes métodos “getter” para incorporação de painéis que os desenvolvedores podem usar.

Método Descrição

getFilterGroupsForSheet(sheetId: string)

Retorna todos os FilterGroups delimitados, no momento, para a planilha fornecida no parâmetro.

getFilterGroupsForVisual(sheetId: string, visualId: string)

Retorna todos os FilterGroups delimitados para o elemento visual fornecido no parâmetro.

Se a planilha fornecida no parâmetro não for a planilha selecionada no painel incorporado no momento, os métodos acima mencionados retornarão um erro.

Métodos “getter” para incorporação de elementos visuais

A tabela apresentada a seguir descreve os diferentes métodos “getter” para incorporação de elementos visuais que os desenvolvedores podem usar.

Método Descrição

getFilterGroups()

Retorna todos os FilterGroups delimitados, no momento, para o elemento visual incorporado.

Métodos “setter”

A tabela apresentada a seguir descreve diferentes métodos “setter” que os desenvolvedores podem usar para realizar a incorporação de painéis ou de elementos visuais.

Método Descrição

addFilterGroups(filterGroups: FilterGroup[])

Adiciona e aplica os FilterGroups fornecidos ao painel ou ao elemento visual incorporado. Uma ResponseMessage que indica se a adição ocorreu com êxito é retornada.

updateFilterGroups(filterGroups: FilterGroup[])

Atualiza os FilterGroups na experiência incorporada que contêm um FilterGroupId semelhante ao do FilterGroup fornecido no parâmetro. Uma ResponseMessage que indica se a atualização ocorreu com êxito é retornada.

removeFilterGroups(filterGroupsOrIds: FilterGroup[] | string[])

Remove os FilterGroups fornecidos do painel e retorna uma ResponseMessage que indica se a tentativa de remoção ocorreu com êxito.

O FilterGroup fornecido deve estar associado à planilha ou ao elemento visual incorporado que está selecionado no momento.