Filtraggio dei dati in fase di esecuzione per pannelli di controllo e immagini integrati di Amazon Quick Sight - Amazon Quick Suite

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Filtraggio dei dati in fase di esecuzione per pannelli di controllo e immagini integrati di Amazon Quick Sight

Puoi utilizzare i metodi di filtro nell'SDK di incorporamento Amazon Quick Sight per sfruttare la potenza dei filtri Amazon Quick Sight all'interno della tua applicazione Software as a Service (SaaS) in fase di esecuzione. I filtri di runtime consentono agli imprenditori di integrare la propria applicazione con i pannelli di controllo e gli elementi visivi incorporati di Amazon Quick Sight. A tale scopo, crea controlli di filtro personalizzati nell'applicazione e applicate filtri preimpostati in base ai dati dell'applicazione. Quindi, gli sviluppatori possono personalizzare le configurazioni dei filtri per gli utenti finali durante il runtime.

Gli sviluppatori possono creare, interrogare, aggiornare e rimuovere i filtri Amazon Quick Sight su un pannello di controllo o un elemento visivo incorporato dalla loro applicazione con Amazon Quick Sight Embedding SDK. Crea oggetti filtro Amazon Quick Sight nella tua applicazione con il modello di FilterGroupdati e applicali a dashboard e immagini incorporate utilizzando i metodi di filtro. Per ulteriori informazioni sull'utilizzo di Amazon Quick Sight Embedding SDK, consulta la amazon-quicksight-embedding-sdkpagina. GitHub

Prerequisiti

Prima di iniziare, assicurati di utilizzare Amazon Quick Sight Embedding SDK versione 2.5.0 o successiva.

Concetti e terminologia

La seguente terminologia può essere utile quando lavori con il filtro di runtime incorporato.

  • Gruppo di filtri: un gruppo di filtri individuali. I filtri che si trovano all'interno di un FilterGroup vengono introdotti da un operatore OR l'uno con l'altro. I filtri all'interno di a FilterGroupvengono applicati agli stessi fogli o immagini.

  • Filtro: un singolo filtro. Il filtro può essere di tipo di filtro di categoria, numerico o data/ora. Per ulteriori informazioni sui filtri, consulta Filtri.

Configurazione

Prima di cominciare, assicurati di disporre delle seguenti risorse e informazioni.

  • L'ID del foglio a cui si desidera applicare l'ambito di FilterGroup. Questo può essere ottenuto con il metodo getSheets dell'SDK Embedding.

  • L'identificativo di set di dati e colonna da filtrare. Ciò può essere ottenuto tramite l'operazione DescribeDashboardDefinitionAPI.

    A seconda del tipo di colonna utilizzato, potrebbero esserci restrizioni sui tipi di filtri che possono essere aggiunti a una risorsa incorporata. Per ulteriori informazioni sulle restrizioni dei filtri, consulta Filtri.

  • L'ID dell'elemento visivo dell'oggetto visivo a cui applicare l'ambito di FilterGroup, se applicabile. Questo può essere ottenuto con il metodo getSheetVisuals dell'SDK Embedding.

    Oltre al metodo getSheetVisuals, il FilterGroup che aggiungi può essere limitato solo al foglio attualmente selezionato.

Per utilizzare questa funzionalità, devi già disporre di una dashboard o di un elemento visivo incorporato nell'applicazione tramite Amazon Quick Sight Embedding SDK. Per ulteriori informazioni sull'utilizzo di Amazon Quick Sight Embedding SDK, consulta la amazon-quicksight-embedding-sdkpagina. GitHub

Interfaccia del metodo SDK

Metodi getter di incorporamento del pannello di controllo

La tabella seguente descrive i diversi metodi getter di incorporamento del pannello di controllo che gli sviluppatori possono utilizzare.

Metodo Description

getFilterGroupsForSheet(sheetId: string)

Restituisce tutto FilterGroups ciò che è attualmente compreso nell'ambito del foglio fornito nel parametro.

getFilterGroupsForVisual(sheetId: string, visualId: string)

Restituisce tutti i FilterGroups attualmente compresi nell'ambito del foglio fornito nel parametro.

Se il foglio fornito nel parametro non è il foglio attualmente selezionato del pannello di controllo incorporato, i metodi precedenti restituiscono un errore.

Metodi getter di incorporamento degli elementi visivi

La tabella seguente descrive i diversi metodi getter di incorporamento degli elementi visivi che gli sviluppatori possono utilizzare.

Metodo Description

getFilterGroups()

Restituisce tutti i FilterGroups che sono attualmente inclusi nell'elemento visivo incorporato.

Metodi setter

La tabella seguente descrive i diversi metodi setter che gli sviluppatori possono utilizzare per l'incorporamento del pannello di controllo o dell'elemento visivo.

Metodo Description

addFilterGroups(filterGroups: FilterGroup[])

Aggiunge e applica il valore fornito FilterGroupsalla dashboard o alla grafica incorporata. Un ResponseMessage che indica se l'aggiunta è avvenuta correttamente.

updateFilterGroups(filterGroups: FilterGroup[])

Aggiorna FilterGroups sull'esperienza incorporata che contiene lo stesso FilterGroupId del FilterGroup fornito nel parametro. Un ResponseMessage che indica se l'aggiornamento è avvenuto correttamente.

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

Rimuove l'elemento fornito FilterGroups dal pannello di controllo e restituisce un messaggio ResponseMessage che indica se il tentativo di rimozione è riuscito.

Il FilterGroup che viene fornito deve essere limitato al foglio o all'elemento visivo incorporato attualmente selezionato.