在运行时筛选嵌入式仪表板和视觉对象的数据 - Amazon QuickSight
术语和概念设置SDK 方法接口
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

在运行时筛选嵌入式仪表板和视觉对象的数据

您可以在 Amazon QuickSight 嵌入软件开发工具包中使用 QuickSight 筛选方法，在运行时利用软件即服务 (SaaS) 应用程序中筛选器的强大功能。运行时筛选器允许企业主将其应用程序与嵌入式 QuickSight 仪表板和视觉对象集成。为此，请在应用程序中创建自定义的过滤器控件，并根据应用程序中的数据应用过滤器预设。然后，开发人员可以在运行时为最终用户个性化过滤器配置。

开发人员可以使用 Embedding SDK 在嵌入式仪表板上创建、查询、更新和移除筛选器或应用程序中的 QuickSight 视觉对象。使用FilterGroup数据模型在应用程序中创建 QuickSight 筛选器对象，并使用筛选方法将其应用于嵌入式仪表板和视觉对象。有关使用 Embedding QuickSight SDK 的更多信息，请参阅amazon-quicksight-embedding-sdk上的 GitHub。

先决条件

在开始之前，请确保您使用的是 Embedding SDK QuickSight 版本 2.5.0 或更高版本。

术语和概念

使用嵌入式运行时筛选时，以下术语可能很有用。

  • 筛选器组-一组单独的过滤器。位于 a FilterGroup 内的过滤器彼此之间进行 OR 运算。中的筛选FilterGroup器应用于相同的工作表或视觉对象。

  • 过滤器-单个过滤器。筛选器可以是类别、数字或日期时间筛选器类型。有关筛选器的更多信息，请参阅筛选器。

设置

在开始之前，请确保准备好以下资产和信息。

  • 要将范围限定到的工作表的工作表 ID。FilterGroup这可以通过 Embedding SDK 中的getSheets方法获得。

  • 要筛选的数据集的数据集和列标识符。这可以通过 DescribeDashboardDefinitionAPI 操作获得。

    根据您使用的列类型，可以添加到嵌入式资产的筛选器类型可能会受到限制。有关筛选器限制的更多信息，请参阅筛选。

  • 如果适用，您要将范围限定为的视觉效果FilterGroup的视觉 ID。这可以通过使用 Embedding SDK 中的getSheetVisuals方法获得。

    除了该getSheetVisuals方法之外，您添加FilterGroup的只能限定到当前选定的工作表。

要使用此功能，您必须已经通过 Embedding SDK 将仪表板或视觉效果 QuickSight 嵌入到应用程序中。有关使用 Embedding S QuickSight DK 的更多信息，请参阅 [Quip 中的错误链接]。

SDK 方法接口

仪表板嵌入获取器方法

下表描述了开发人员可以使用的不同仪表板嵌入获取器方法。

方法 描述

getFilterGroupsForSheet(sheetId: string)

返回当前限 FilterGroups 定为参数中提供的表单的所有内容。

getFilterGroupsForVisual(sheetId: string, visualId: string)

返回FilterGroups所有范围限于参数中提供的视觉效果的内容。

如果参数中提供的工作表不是嵌入式仪表板中当前选定的工作表，则上述方法会返回错误。

可视化嵌入获取器方法

下表描述了开发人员可以使用的不同可视化嵌入获取器方法。

方法 描述

getFilterGroups()

返回当前限FilterGroups定为嵌入式视觉对象的所有内容。

设置器方法

下表描述了开发人员可用于仪表板或视觉嵌入的不同设置方法。

方法 描述

addFilterGroups(filterGroups: FilterGroup[])

将提供的内容添加并应用FilterGroups到嵌入式仪表板或视觉对象。返回ResponseMessage表示添加是否成功的 A。

updateFilterGroups(filterGroups: FilterGroup[])

更新包含与参数中提供的FilterGroupId相同体验FilterGroup的嵌入式体验。FilterGroups返回ResponseMessage表示更新是否成功的。

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

FilterGroups 从仪表板中移除提供的内容，并返回 a，ResponseMessage表示删除尝试是否成功。

提供的FilterGroup内容必须限定为当前选定的嵌入式工作表或视觉对象。