在運行時過濾內嵌儀表板和視覺效果的數據

您可以在 Amazon QuickSight 嵌入 SDK 中使用篩選方法，在執行階段利用軟體即服務 (SaaS) 應用程式中的篩選 QuickSight 器功能。運行時過濾器允許企業所有者將其應用程序與嵌入式 QuickSight 儀表板和視覺效果集成 若要完成此操作，請在應用程式中建立自訂的濾鏡控制項，並根據應用程式中的資料套用濾鏡預設集。然後，開發人員可以在運行時為最終用戶個性化過濾器配置。

開發人員可以使用 QuickSight 嵌入 SDK 從應用程式建立、查詢、更新和移除內嵌儀表板上的篩選器或視覺效果。使用FilterGroup資料模型在應用程式中建立 QuickSight 篩選器物件，並使用篩選方法將其套用至內嵌儀表板和視覺效果。有關如何使用 QuickSight 嵌入 SDK 的更多內容，敬請參閱（詳見） GitHub。amazon-quicksight-embedding-sdk

先決條件

在您開始使用之前，請確定您使用的是 QuickSight 嵌入 SDK 2.5.0 或更新版本。

術語與概念

使用內嵌執行階段篩選時，下列術語非常有用。

• 篩選群組 — 一組個別篩選器。位於 a 中的篩選器FilterGroup會相互連接。a 中的篩選器FilterGroup會套用至相同的工作表或視覺效果。

• 篩選 — 單一篩選器。篩選器可以是類別、數字或日期時間篩選器類型。如需篩選器的詳細資訊，請參閱篩選。

設定

在開始之前，請確定您已準備好下列資產和資訊。

• 您要範圍為的工作表的工作表 FilterGroup ID。這可以通過嵌入 SDK 中的getSheets方法來獲得。

• 您要篩選之資料集的資料集和資料行識別碼。這可以通過 DescribeDashboardDefinitionAPI 操作獲得。

  視您使用的欄類型而定，可以新增至內嵌資產的篩選器類型可能會受到限制。如需篩選器限制的詳細資訊，請參閱篩選器。

• 您要範圍的視覺效果的視覺識別碼 (如果適用的話)。FilterGroup這可以通過使用嵌入 SDK 中的getSheetVisuals方法來獲得。

  除了getSheetVisuals方法之外，您加入的FilterGroup項目只能設定為目前選取的工作表的範圍。

若要使用此功能，您必須已透過 QuickSight 嵌入 SDK 將儀表板或視覺內嵌到應用程式中。有關使用 QuickSight 嵌入 SDK 的更多信息，請參閱 [Quip 中的錯誤鏈接]。

SDK 方法介面

儀表板嵌入吸氣方法

下表描述了開發人員可以使用不同的儀表板嵌入 getter 方法。

方法	描述
getFilterGroupsForSheet(sheetId: string)	返回當前範圍為參數中提供的工作表的所 FilterGroups 有內容。
getFilterGroupsForVisual(sheetId: string, visualId: string)	返回範圍FilterGroups為參數中提供的視覺效果的所有內容。

如果參數中提供的工作表不是目前選取的嵌入式儀表板工作表，上述方法會傳回錯誤。

可視化嵌入吸氣方法

下表描述了開發人員可以使用的不同視覺嵌入 getter 方法。

方法	描述
getFilterGroups()	返回當前範圍為嵌入式視FilterGroups覺效果的所有內容。

二傳手方法

下表描述了開發人員可以用於儀表板或視覺嵌入不同的 setter 方法。

方法	描述
addFilterGroups(filterGroups: FilterGroup[])	添加並應用提供FilterGroups給嵌入式儀表板或可視化。會ResponseMessage傳回指出新增是否成功。
updateFilterGroups(filterGroups: FilterGroup[])	更新內FilterGroups嵌體驗，該體驗包含FilterGroupId與參FilterGroup數中提供的相同。會ResponseMessage傳回指出更新是否成功。
removeFilterGroups(filterGroupsOrIds: FilterGroup[] | string[])	FilterGroups 從儀表板移除提供的，並傳回 aResponseMessage，指出移除嘗試是否成功。

提供FilterGroup的範圍必須設定為目前選取的內嵌工作表或視覺效果。