Filtragem de dados em tempo de execução para painéis e recursos visuais incorporados

Você pode usar métodos de filtro na QuickSight incorporação da Amazon SDK para aproveitar o poder dos QuickSight filtros em seu aplicativo de software como serviço (SaaS) em tempo de execução. Os filtros de tempo de execução permitem que os proprietários de empresas integrem seus aplicativos aos QuickSight painéis e recursos visuais incorporados. Para fazer isso, crie controles de filtro personalizados em seu aplicativo e aplique predefinições de filtro com base nos dados do seu aplicativo. Em seguida, os desenvolvedores podem personalizar as configurações de filtro para os usuários finais em tempo de execução.

Os desenvolvedores podem criar, consultar, atualizar e remover filtros em um painel incorporado ou visual de seu aplicativo com o QuickSight EmbeddingSDK. Crie objetos de QuickSight filtro em seu aplicativo com o modelo de FilterGroupdados e aplique-os a painéis e recursos visuais incorporados usando os métodos de filtro. Para obter mais informações sobre como usar o QuickSight EmbeddingSDK, consulte o amazon-quicksight-embedding-sdkon GitHub.

Pré-requisitos

Antes de começar, verifique se você está usando a SDK versão 2.5.0 ou superior do QuickSight Embedding.

Terminologia e conceitos

A terminologia a seguir pode ser útil ao trabalhar com filtragem de tempo de execução incorporada.

• Grupo de filtros — Um grupo de filtros individuais. Os filtros que estão localizados dentro de a FilterGroup são interligados entre si. Os filtros dentro de a FilterGroupsão aplicados às mesmas pastas ou imagens.

• 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 filtros, consulte Filtrar.

Configuração

Antes de começar, verifique se você tem os seguintes ativos e informações preparados.

• O ID da planilha para a qual você deseja FilterGroup definir o escopo. Isso pode ser obtido com o getSheets método na Incorporação. SDK

• O conjunto de dados e o identificador da coluna do conjunto de dados que você deseja filtrar. Isso pode ser obtido por meio da DescribeDashboardDefinitionAPIoperação.

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

• A ID visual do visual para o qual você deseja FilterGroup definir o escopo, se aplicável. Isso pode ser obtido usando o getSheetVisuals método na Incorporação. SDK

  Além do getSheetVisuals método, o FilterGroup que você adiciona só pode ter como escopo a planilha atualmente selecionada.

Para usar esse recurso, você já deve ter um painel ou visual incorporado ao seu aplicativo por meio da QuickSight IncorporaçãoSDK. Para obter mais informações sobre o uso da QuickSight IncorporaçãoSDK, consulte [link errado no Quip].

SDKinterface de método

Métodos melhores de incorporação de painéis

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

Método	Descrição
getFilterGroupsForSheet(sheetId: string)	Retorna tudo o FilterGroups que está atualmente definido para a planilha fornecida no parâmetro.
getFilterGroupsForVisual(sheetId: string, visualId: string)	Retorna tudo o FilterGroups que tem escopo para o visual fornecido no parâmetro.

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

Métodos aprimoradores de incorporação visual

A tabela a seguir descreve diferentes métodos de obtenção de incorporação visual que os desenvolvedores podem usar.

Método	Descrição
getFilterGroups()	Retorna tudo FilterGroups o que está atualmente definido no escopo para o visual incorporado.

Métodos setter

A tabela a seguir descreve diferentes métodos de configuração que os desenvolvedores podem usar para incorporação visual ou de painel.

Método	Descrição
addFilterGroups(filterGroups: FilterGroup[])	Adiciona e aplica o fornecido FilterGroupsao painel ou visual incorporado. Um ResponseMessage que indica se a adição foi bem-sucedida é retornado.
updateFilterGroups(filterGroups: FilterGroup[])	Atualiza FilterGroups a experiência incorporada que contém a FilterGroupId mesma FilterGroup que é fornecida no parâmetro. Um ResponseMessage que indica se a atualização foi bem-sucedida é retornado.
removeFilterGroups(filterGroupsOrIds: FilterGroup[] | string[])	Remove o fornecido FilterGroups do painel e retorna um ResponseMessage que indica se a tentativa de remoção foi bem-sucedida.

O FilterGroup que é fornecido deve ter como escopo a pasta incorporada ou o visual selecionado atualmente.