Filtrado de datos en tiempo de ejecución para elementos visuales y paneles incrustados de QuickSight - Amazon QuickSight
Terminología y conceptosConfiguraciónInterfaz del método del SDK

Filtrado de datos en tiempo de ejecución para elementos visuales y paneles incrustados de QuickSight

Puede usar los métodos de filtrado del SDK de incrustación de Amazon QuickSight para aprovechar la potencia que ofrecen los filtros de QuickSight en 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 sus aplicaciones con sus elementos visuales y paneles de QuickSight incrustados. Para ello, cree controles de filtro personalizados en su aplicación y aplique valores predeterminados de filtros en función de los datos de su aplicación. De este modo, los desarrolladores pueden personalizar las configuraciones de los filtros para los usuarios finales en tiempo de ejecución.

Los desarrolladores pueden crear, consultar, actualizar y eliminar filtros en un panel integrado o en un elemento visual de su aplicación con el SDK de incrustación de QuickSight. Cree objetos de filtro de QuickSight en su aplicación con el modelo de datos FilterGroup y aplíquelos a elementos visuales y paneles incrustados mediante los métodos de filtrado. Para obtener más información sobre el uso del SDK de integración de QuickSight, consulte amazon-quicksight-embedding-sdk en GitHub.

Requisitos previos 

Antes de empezar, asegúrese de que usa la versión 2.5.0 del SDK de incrustación de QuickSight o una versión superior.

Terminología y conceptos

La siguiente terminología puede resultar útil cuando trabaje con el filtrado de tiempo de ejecución incrustado.

  • Grupo de filtros: grupo de filtros individuales. Los filtros que se encuentran dentro de un FilterGroup están conectados entre sí mediante el operador OR. Los filtros de FilterGroup se aplican a las mismas hojas o elementos visuales.

  • 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 filtros, consulte Filtro.

Configuración

Antes de comenzar, asegúrese de que tiene preparados los activos y la información que se indican a continuación.

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

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

    En función del tipo de columna que use, es posible que haya restricciones en cuanto a los tipos de filtro que se pueden agregar a un activo incrustado. Para obtener más información sobre las restricciones de los filtros, consulte Filtrar.

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

    Además del método getSheetVisuals, el FilterGroup que agregue solo puede tener como ámbito la hoja actualmente seleccionada.

Para usar esta característica, ya debe tener un panel o un elemento visual incrustados en su aplicación a través del SDK de incrustación de QuickSight. Para obtener más información sobre el uso del SDK de integración de QuickSight, consulte amazon-quicksight-embedding-sdk en GitHub.

Interfaz del método del SDK

Métodos getter de incrustación del panel

En la siguiente tabla se describen los diferentes métodos getter de incrustación de panel que pueden usar los desarrolladores.

Método Descripción

getFilterGroupsForSheet(sheetId: string)

Devuelve todos los FilterGroups que actualmente tienen como ámbito la hoja que se proporciona en el parámetro.

getFilterGroupsForVisual(sheetId: string, visualId: string)

Devuelve todos los FilterGroups que tienen como ámbito el elemento 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 incrustado, los métodos anteriores devolverán un error.

Métodos getter de incrustación de elemento visual

En la siguiente tabla se describen los diferentes métodos getter de incrustación de elemento visual que pueden usar los desarrolladores.

Método Descripción

getFilterGroups()

Devuelve todos los FilterGroups que actualmente tienen como ámbito el elemento visual incrustado.

Métodos Setter

En la siguiente tabla se describen los diferentes métodos setter que los desarrolladores pueden usar para la incrustación de paneles o elementos visuales.

Método Descripción

addFilterGroups(filterGroups: FilterGroup[])

Agrega y aplica los FilterGroups suministrados al elemento visual o panel incrustados. Se devuelve un mensaje ResponseMessage que indica si la incorporación se realizó correctamente.

updateFilterGroups(filterGroups: FilterGroup[])

Actualiza FilterGroups en la experiencia incrustada que contiene el mismo FilterGroupId que el FilterGroup que se proporciona en el parámetro. Se devuelve un mensaje ResponseMessage que indica si la actualización se realizó correctamente.

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

Elimina los FilterGroups suministrados del panel y devuelve un ResponseMessage que indica si el intento de eliminación se ha realizado correctamente.

El FilterGroup que se proporciona debe tener como ámbito los elementos visuales o las hojas incrustados actualmente seleccionados.