Filtrar datos en tiempo de ejecución para paneles e imágenes integrados

Puede utilizar métodos de filtrado en la QuickSight incrustación de Amazon SDK para aprovechar la potencia de QuickSight los filtros de su aplicación de software como servicio (SaaS) en tiempo de ejecución. Los filtros de tiempo de ejecución permiten a los propietarios de empresas integrar su aplicación con sus QuickSight paneles e imágenes integrados. Para ello, cree controles de filtro personalizados en su aplicación y aplique filtros preestablecidos en función de los datos de la aplicación. Luego, los desarrolladores pueden personalizar las configuraciones de los filtros para los usuarios finales en tiempo de ejecución.

Con la QuickSight incrustaciónSDK, los desarrolladores pueden crear, consultar, actualizar y eliminar filtros de un panel integrado o de una imagen de su aplicación. Cree objetos de QuickSight filtro en su aplicación con el modelo de FilterGroupdatos y aplíquelos a cuadros de mando e imágenes integrados mediante los métodos de filtrado. Para obtener más información sobre el uso de la QuickSight incrustaciónSDK, consulte la amazon-quicksight-embedding-sdk GitHub

Requisitos previos 

Antes de empezar, asegúrese de que está utilizando la SDK versión 2.5.0 o superior de QuickSight Embedding.

Terminología y conceptos

La siguiente terminología puede resultar útil cuando se trabaja con el filtrado en tiempo de ejecución integrado.

• Grupo de filtros: grupo de filtros individuales. Los filtros que se encuentran dentro de un FilterGroup están conectados entre sí. Los filtros dentro de a FilterGroupse aplican a las mismas hojas o imágenes.

• Filtro: un filtro único. El filtro puede ser de categoría, numérico o de fecha y hora. Para obtener más información sobre los filtros, consulte Filtro.

Configuración

Antes de empezar, asegúrese de tener preparados los siguientes recursos e información.

• El identificador de la hoja a la que desea FilterGroup hacer el seguimiento. Esto se puede obtener con el getSheets método de la incrustación. SDK

• El conjunto de datos y el identificador de columna del conjunto de datos que desea filtrar. Esto se puede obtener mediante la DescribeDashboardDefinitionAPIoperación.

  Según el tipo de columna que utilice, es posible que haya restricciones en cuanto a los tipos de filtros que se pueden añadir a un recurso integrado. Para obtener más información sobre las restricciones de los filtros, consulte Filtrar.

• El identificador visual del elemento visual al que desea FilterGroup aplicar el alcance, si corresponde. Esto se puede obtener mediante el getSheetVisuals método de la incrustación. SDK

  Además del getSheetVisuals método, lo FilterGroup que añada solo puede abarcar la hoja actualmente seleccionada.

Para utilizar esta función, debe tener ya un panel de control o un elemento visual integrado en la aplicación mediante la QuickSight incrustaciónSDK. Para obtener más información sobre el uso de la QuickSight incrustaciónSDK, consulte [enlace incorrecto en Quip].

SDKinterfaz de métodos

Métodos de captación de incrustaciones en el panel

En la siguiente tabla se describen los diferentes métodos de captación de incrustaciones de cuadros de mando que pueden utilizar los desarrolladores.

Método	Descripción
getFilterGroupsForSheet(sheetId: string)	Devuelve todo lo FilterGroups que está actualmente limitado a la hoja que se proporciona en el parámetro.
getFilterGroupsForVisual(sheetId: string, visualId: string)	Devuelve todo FilterGroups lo que tiene el alcance visual que se proporciona en el parámetro.

Si la hoja que se proporciona en el parámetro no es la hoja actualmente seleccionada del panel integrado, los métodos anteriores devuelven un error.

Métodos visuales de captación de incrustaciones

En la siguiente tabla se describen los distintos métodos de captación visual de incrustaciones que pueden utilizar los desarrolladores.

Método	Descripción
getFilterGroups()	Devuelve todo lo FilterGroups que se ha centrado actualmente en el elemento visual incrustado.

Métodos Setter

En la siguiente tabla se describen los diferentes métodos de creación que los desarrolladores pueden utilizar para la incrustación visual o en el panel de control.

Método	Descripción
addFilterGroups(filterGroups: FilterGroup[])	Agrega y aplica lo suministrado FilterGroupsal panel de control o imagen incrustado. Se devuelve un ResponseMessage que indica si la adición se realizó correctamente.
updateFilterGroups(filterGroups: FilterGroup[])	Actualiza FilterGroups la experiencia integrada que contiene lo FilterGroupId mismo FilterGroup que la que se proporciona en el parámetro. Se devuelve un mensaje ResponseMessage que indica si la actualización se ha realizado correctamente.
removeFilterGroups(filterGroupsOrIds: FilterGroup[] | string[])	Elimina lo suministrado del panel FilterGroups de control y devuelve un ResponseMessage que indica si el intento de eliminación se ha realizado correctamente.

Lo FilterGroup que se suministra debe estar limitado a la hoja o imagen incrustada que esté actualmente seleccionada.