Filterung von Daten zur Laufzeit für eingebettete Dashboards und Grafiken

Sie können Filtermethoden in der QuickSight Amazon-Einbettung verwendenSDK, um die Leistungsfähigkeit der QuickSight Filter in Ihrer SaaS-Anwendung (Software as a Service) zur Laufzeit zu nutzen. Runtime-Filter ermöglichen es Geschäftsinhabern, ihre Anwendung in ihre eingebetteten QuickSight Dashboards und Grafiken zu integrieren. Erstellen Sie dazu benutzerdefinierte Filtersteuerelemente 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 mithilfe der QuickSight Einbettung SDK Filter für ein eingebettetes Dashboard oder eine Grafik aus ihrer Anwendung erstellen, abfragen, aktualisieren und entfernen. Erstellen Sie QuickSight Filterobjekte in Ihrer Anwendung mit dem FilterGroupDatenmodell und wenden Sie sie mithilfe der Filtermethoden auf eingebettete Dashboards und Grafiken an. Weitere Informationen zur Verwendung der QuickSight Einbettung finden Sie SDK unter. amazon-quicksight-embedding-sdk GitHub

Voraussetzungen

Bevor Sie beginnen können, stellen Sie sicher, dass Sie die QuickSight SDK Embedding-Version 2.5.0 oder höher verwenden.

Terminologie und Konzepte

Die folgende Terminologie kann bei der Arbeit mit eingebetteter Laufzeitfilterung nützlich sein.

• Filtergruppe — Eine Gruppe einzelner Filter. Filter, die sich innerhalb von befinden, FilterGroup sind miteinander ODER-verknüpft. Filter innerhalb von FilterGroupwerden auf dieselben Blätter oder Grafiken 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 sicher, dass Sie die folgenden Ressourcen und Informationen vorbereitet haben.

• Die Blatt-ID des Blattes, auf das Sie den Bereich beschränken FilterGroup möchten. Dies kann mit der getSheets Methode in der Einbettung SDK abgerufen werden.

• Der Datensatz und die Spalten-ID des Datensatzes, den Sie filtern möchten. Dies kann durch die DescribeDashboardDefinitionAPIOperation erreicht werden.

  Je nachdem, welchen Spaltentyp Sie verwenden, kann es Einschränkungen hinsichtlich der Filtertypen geben, die einem eingebetteten Asset hinzugefügt werden können. Weitere Informationen zu Filtereinschränkungen finden Sie unter Filter.

• Falls zutreffend, die visuelle ID des visuellen Elements, auf das Sie FilterGroup den Bereich beschränken möchten. Dies kann mithilfe der getSheetVisuals Methode in der Einbettung SDK abgerufen werden.

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

Um diese Funktion nutzen zu können, müssen Sie bereits ein Dashboard oder eine Grafik über die Einbettung in Ihre Anwendung eingebettet haben. QuickSight SDK Weitere Informationen zur Verwendung der QuickSight Einbettung SDK finden Sie unter [falscher Link in Quip].

SDKMethodenschnittstelle

Dashboard, das bessere Methoden einbettet

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 Daten zurück, die sich derzeit auf das im Parameter angegebene Blatt beziehen.
getFilterGroupsForVisual(sheetId: string, visualId: string)	Gibt alle FilterGroups Werte zurück, die sich auf das im Parameter angegebene Bild beziehen.

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.

Bessere Methoden zum visuellen Einbetten

In der folgenden Tabelle werden verschiedene Getter-Methoden für die visuelle Einbettung beschrieben, die Entwickler verwenden können.

Methode	Beschreibung
getFilterGroups()	Gibt alle Daten zurückFilterGroups, die sich derzeit auf das eingebettete Bild beziehen.

Setter-Methoden

In der folgenden Tabelle werden verschiedene Setter-Methoden beschrieben, die Entwickler für Dashboards oder visuelle Einbettung verwenden können.

Methode	Beschreibung
addFilterGroups(filterGroups: FilterGroup[])	Fügt das Bereitgestellte hinzu und wendet FilterGroupses auf das eingebettete Dashboard oder die Grafik an. Ein WertResponseMessage, der angibt, ob das Hinzufügen erfolgreich war, wird zurückgegeben.
updateFilterGroups(filterGroups: FilterGroup[])	FilterGroupsAktualisiert das eingebettete Erlebnis, das dasselbe enthält FilterGroupId wie dasFilterGroup, das im Parameter angegeben ist. Ein WertResponseMessage, der angibt, ob das Update erfolgreich war, wird zurückgegeben.
removeFilterGroups(filterGroupsOrIds: FilterGroup[] | string[])	Entfernt das angegebene Objekt FilterGroups aus dem Dashboard und gibt ein zurückResponseMessage, das angibt, ob der Entfernungsversuch erfolgreich war.

FilterGroupDas bereitgestellte Objekt muss sich auf das eingebettete Arbeitsblatt oder die Grafik beziehen, die derzeit ausgewählt ist.