Filtern von Daten zur Laufzeit für eingebettete QuickSight-Dashboards und -Visualisierungen - Amazon QuickSight
Terminologie und KonzepteEinrichtungSDK-Methodenschnittstelle

Filtern von Daten zur Laufzeit für eingebettete QuickSight-Dashboards und -Visualisierungen

Sie können Filtermethoden im Amazon QuickSight-Embedding-SDK verwenden, um die Leistungsfähigkeit der QuickSight-Filter in Ihrer SaaS-Anwendung (Software as a Service) zur Laufzeit zu nutzen. Laufzeitfilter ermöglichen es Geschäftsinhabern, ihre Anwendung in ihre eingebetteten QuickSight-Dashboards und -Visualisierungen zu integrieren. Um dies zu erreichen, erstellen Sie benutzerdefinierte Filtersteuerungen in Ihrer Anwendung und wenden Sie Filtervoreinstellungen an, die auf Daten aus Ihrer Anwendung basieren. Anschließend können Entwickler zur Laufzeit Filterkonfigurationen für Endbenutzer personalisieren.

Entwickler können mit dem QuickSight Embedding SDK QuickSight-Filter in einem eingebetteten Dashboard oder einer Visualisierung aus ihrer Anwendung erstellen, abfragen, aktualisieren und entfernen. Erstellen Sie QuickSight-Filterobjekte in Ihrer Anwendung mit dem Datenmodell FilterGroup und wenden Sie sie mithilfe der Filtermethoden auf eingebettete Dashboards und Visualisierungen an. Weitere Informationen zur Verwendung des QuickSight Embedding SDK finden Sie im amazon-quicksight-embedding-sdk auf GitHub.

Voraussetzungen

Bevor Sie beginnen, stellen Sie sicher, dass Sie das QuickSight Embedding SDK Version 2.5.0 oder höher verwenden.

Terminologie und Konzepte

Die folgende Terminologie kann nützlich sein, wenn Sie mit eingebetteten Laufzeitfiltern arbeiten.

  • Filtergruppe – Eine Gruppe einzelner Filter. Filter, die sich innerhalb einer FilterGroup befinden, sind miteinander ODER-verknüpft. Filter innerhalb einer FilterGroup werden auf dieselben Blätter oder Visualisierungen angewendet.

  • Filter – Ein einzelner Filter. Bei dem Filter kann es sich um einen Kategorien-, numerischen oder Datums-/Uhrzeitfilter handeln. Weitere Informationen zu Filtern finden Sie unter Filter.

Einrichtung

Bevor Sie beginnen, stellen Sie bitte sicher, dass Sie die folgenden Ressourcen und Informationen bereit haben.

  • Die Blatt-ID des Blatts, auf das Sie die FilterGroup beschränken möchten. Dies kann mit der Methode getSheets im Embedding SDK abgerufen werden.

  • Der Datensatz und die Spalten-ID des Datensatzes, den Sie filtern möchten. Dies kann über den API-Vorgang DescribeDashboardDefinition abgerufen werden.

    Je nach verwendetem Spaltentyp kann es Einschränkungen hinsichtlich der Filtertypen geben, die einer eingebetteten Ressource hinzugefügt werden können. Weitere Informationen zu Filterbeschränkungen finden Sie unter Filter.

  • Falls zutreffend, die visuelle ID der Visualisierung, auf das Sie die FilterGroup beschränken möchten. Dies kann mit der Methode getSheetVisuals im Embedding SDK abgerufen werden.

    Zusätzlich zu der Methode getSheetVisuals kann die FilterGroup, die Sie hinzufügen, nur auf das aktuell ausgewählte Blatt beschränkt werden.

Um dieses Feature nutzen zu können, müssen Sie bereits über das QuickSight Embedding SDK ein Dashboard oder eine Visualisierung in Ihre Anwendung eingebettet haben. Weitere Informationen zur Verwendung des QuickSight Embedding SDK finden Sie im amazon-quicksight-embedding-sdk auf GitHub.

SDK-Methodenschnittstelle

Getter-Methoden der Dashboard-Einbettung

In der folgenden Tabelle werden verschiedene Getter-Methoden zum Einbetten von Dashboards beschrieben, die Entwickler verwenden können.

Methode Beschreibung

getFilterGroupsForSheet(sheetId: string)

Gibt alle FilterGroups zurück, die derzeit auf das im Parameter angegebene Blatt beschränkt sind.

getFilterGroupsForVisual(sheetId: string, visualId: string)

Gibt alle FilterGroups zurück, die auf die im Parameter angegebene Visualisierung beschränkt sind.

Wenn das im Parameter angegebene Blatt nicht das aktuell ausgewählte Blatt des eingebetteten Dashboards ist, geben die oben genannten Methoden einen Fehler zurück.

Getter-Methoden der Visualisierungseinbettung

In der folgenden Tabelle werden verschiedene Getter-Methoden zum Einbetten von Visualisierungen beschrieben, die Entwickler verwenden können.

Methode Beschreibung

getFilterGroups()

Gibt alle FilterGroups zurück, die derzeit auf die eingebettete Visualisierung beschränkt sind.

Setter-Methoden

In der folgenden Tabelle werden verschiedene Getter-Methoden zum Einbetten von Dashboards oder Visualisierungen beschrieben, die Entwickler verwenden können.

Methode Beschreibung

addFilterGroups(filterGroups: FilterGroup[])

Fügt die bereitgestellten FilterGroups dem eingebetteten Dashboard oder der Visualisierung hinzu und wendet sie darauf an. Eine ResponseMessage, die angibt, ob das Hinzufügen erfolgreich war, wird zurückgegeben.

updateFilterGroups(filterGroups: FilterGroup[])

Aktualisiert die FilterGroups im Einbettungserlebnis, das dieselbe FilterGroupId enthält wie die FilterGroup, die im Parameter angegeben ist. Eine ResponseMessage, die angibt, ob das Aktualisieren erfolgreich war, wird zurückgegeben.

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

Entfernt die angegebenen FilterGroups aus dem Dashboard und gibt eine ResponseMessage zurück, die angibt, ob der Entfernungsversuch erfolgreich war.

Die angegebene FilterGroup muss sich auf das eingebettete Blatt oder die Visualisierung beschränken, das/die derzeit ausgewählt ist.