本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
在運行時過濾內嵌儀表板和視覺效果的數據
您可以在 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。這可以通過嵌入中的getSheets
方法來獲得SDK。 -
您要篩選之資料集的資料集和資料行識別碼。這可以通過DescribeDashboardDefinitionAPI操作獲得。
視您使用的欄類型而定,可以新增至內嵌資產的篩選器類型可能會受到限制。如需篩選器限制的詳細資訊,請參閱篩選器。
-
您要範圍的視覺效果的視覺識別碼 (如果適用的話)。
FilterGroup
這可以通過使用嵌入中的getSheetVisuals
方法來獲得SDK。除了
getSheetVisuals
方法之外,您加入的FilterGroup
項目只能設定為目前選取的工作表的範圍。
若要使用此功能,您必須已經透過「嵌入」將儀表板或視覺內 QuickSight 嵌到應用程式中SDK。有關使用 QuickSight 嵌入的更多信息SDK,請參閱 [Quip 中的錯誤鏈接]。
SDK方法介面
儀表板嵌入吸氣方法
下表描述了開發人員可以使用不同的儀表板嵌入 getter 方法。
方法 | 描述 |
---|---|
|
返回當前範圍為參數中提供的工作表的所 FilterGroups 有內容。 |
|
返回範圍 |
如果參數中提供的工作表不是目前選取的嵌入式儀表板工作表,上述方法會傳回錯誤。
可視化嵌入吸氣方法
下表描述了開發人員可以使用的不同視覺嵌入 getter 方法。
方法 | 描述 |
---|---|
|
返回當前範圍為嵌入式視 |
二傳手方法
下表描述了開發人員可以用於儀表板或視覺嵌入不同的 setter 方法。
方法 | 描述 |
---|---|
|
添加並應用提供FilterGroups給嵌入式儀表板或可視化。會 |
|
更新內 |
|
FilterGroups 從儀表板移除提供的,並傳回 a |
提供FilterGroup
的範圍必須設定為目前選取的內嵌工作表或視覺效果。