Filtrage des données au moment de l'exécution pour les tableaux de bord et les visuels QuickSight intégrés

Vous pouvez utiliser des méthodes de filtrage dans l' QuickSight intégration d'Amazon SDK pour tirer parti de la puissance des QuickSight filtres au sein de votre application logicielle en tant que service (SaaS) au moment de l'exécution. Les filtres d'exécution permettent aux propriétaires d'entreprise d'intégrer leur application à leurs QuickSight tableaux de bord et visuels intégrés. Pour ce faire, créez des contrôles de filtre personnalisés dans votre application et appliquez des préréglages de filtre en fonction des données de votre application. Les développeurs peuvent ensuite personnaliser les configurations de filtre pour les utilisateurs finaux lors de l'exécution.

Les développeurs peuvent créer, interroger, mettre à jour et supprimer des filtres sur un tableau de bord intégré ou un visuel de leur application grâce à l' QuickSight intégrationSDK. Créez des objets de QuickSight filtre dans votre application à l'aide du modèle de FilterGroupdonnées et appliquez-les aux tableaux de bord et aux visuels intégrés à l'aide des méthodes de filtrage. Pour plus d'informations sur l'utilisation de l' QuickSight intégrationSDK, consultez la section amazon-quicksight-embedding-sdksur GitHub.

Prérequis

Avant de commencer, assurez-vous que vous utilisez la SDK version 2.5.0 ou supérieure d' QuickSight Embedding.

Terminologie et concepts

La terminologie suivante peut être utile lorsque vous utilisez le filtrage d'exécution intégré.

• Groupe de filtres : groupe de filtres individuels. Les filtres situés à l'intérieur d'un FilterGroup sont couplés en OR les uns avec les autres. Les filtres contenus dans a FilterGroupsont appliqués aux mêmes feuilles ou visuels.

• Filtre : filtre unique. Le filtre peut être de type catégorie, numérique ou datetime. Pour plus d'informations sur les filtres, consultez la section Filtre.

Configuration

Avant de commencer, assurez-vous d'avoir préparé les ressources et informations suivantes.

• L'ID de la feuille à laquelle vous souhaitez FilterGroup étendre la portée. Cela peut être obtenu à l'aide de la getSheets méthode décrite dans l'Embedding. SDK

• L'identifiant de l'ensemble de données et de colonne de l'ensemble de données que vous souhaitez filtrer. Cela peut être obtenu par le biais de l'DescribeDashboardDefinitionAPIopération.

  Selon le type de colonne que vous utilisez, les types de filtres pouvant être ajoutés à une ressource incorporée peuvent être soumis à des restrictions. Pour plus d'informations sur les restrictions relatives aux filtres, consultez la section Filtre.

• ID visuel du visuel auquel vous souhaitez étendre le champ d'application, le FilterGroup cas échéant. Cela peut être obtenu en utilisant la getSheetVisuals méthode décrite dans l'Embedding. SDK

  Outre la getSheetVisuals méthode, le champ FilterGroup que vous ajoutez ne peut être étendu qu'à la feuille actuellement sélectionnée.

Pour utiliser cette fonctionnalité, vous devez déjà avoir un tableau de bord ou un visuel intégré à votre application via l' QuickSight intégrationSDK. Pour plus d'informations sur l'utilisation de l' QuickSight intégrationSDK, consultez [lien incorrect dans Quip].

SDKinterface de méthode

Tableau de bord intégrant des méthodes getter

Le tableau suivant décrit les différentes méthodes getter intégrées au tableau de bord que les développeurs peuvent utiliser.

Méthode	Description
getFilterGroupsForSheet(sheetId: string)	Renvoie tout FilterGroups ce qui est actuellement limité à la feuille fournie dans le paramètre.
getFilterGroupsForVisual(sheetId: string, visualId: string)	Renvoie tout FilterGroups ce qui est limité au visuel fourni dans le paramètre.

Si la feuille fournie dans le paramètre n'est pas la feuille actuellement sélectionnée du tableau de bord intégré, les méthodes ci-dessus renvoient une erreur.

Méthodes getter d'intégration visuelle

Le tableau suivant décrit les différentes méthodes d'intégration visuelle que les développeurs peuvent utiliser.

Méthode	Description
getFilterGroups()	Renvoie tout FilterGroups ce qui est actuellement limité au visuel intégré.

Méthodes Setter

Le tableau suivant décrit les différentes méthodes de réglage que les développeurs peuvent utiliser pour le tableau de bord ou l'intégration visuelle.

Méthode	Description
addFilterGroups(filterGroups: FilterGroup[])	Ajoute et applique le contenu fourni FilterGroupsau tableau de bord ou au visuel intégré. Un ResponseMessage qui indique si l'ajout a été effectué avec succès est renvoyé.
updateFilterGroups(filterGroups: FilterGroup[])	Met à jour l'FilterGroupsexpérience intégrée qui contient la même chose FilterGroupId FilterGroup que celle fournie dans le paramètre. Un ResponseMessage qui indique si la mise à jour a réussi est renvoyé.
removeFilterGroups(filterGroupsOrIds: FilterGroup[] | string[])	Supprime le contenu fourni FilterGroups du tableau de bord et renvoie un ResponseMessage indiquant si la tentative de suppression est réussie.

Le FilterGroup contenu fourni doit être limité à la feuille incorporée ou au visuel actuellement sélectionné.