Verwenden von Visualisierungskomponenten zum Rendern benutzerdefinierter Visualisierungen

In diesem Beispiel wird eine benutzerdefinierte Visualisierung gerendert, die lokal für eine in der Entwicklung befindliche App ist, keine benutzerdefinierte Visualisierung, die im Looker Marketplace verfügbar ist.

Looker-Visualisierungskomponenten haben ein Adaptersystem, mit dem Entwickler vorhandene Diagrammtypen überschreiben oder ganz neue Diagrammtypoptionen hinzufügen können.

Diese Option kann in folgenden Fällen nützlich sein:

  • Sie haben benutzerdefinierte React-Visualisierungen erstellt, die Sie mit Looker-Komponenten verwenden möchten.
  • Sie möchten eine vorhandene Looker-Standardvisualisierung durch eine Visualisierung ersetzen, die auf einer anderen Bibliothek basiert.

Die Möglichkeit, Diagramme zu überschreiben oder hinzuzufügen, kann besonders relevant sein, wenn Sie eine Anwendung entwickeln, mit der Nutzer während einer Sitzung die Art der Diagrammvisualisierung ändern können.

Hintergrund

Nachdem Sie eine Abfrage in der Explore-Benutzeroberfläche von Looker gerendert und die Query.client_id an die Visualisierungskomponenten von Looker übergeben haben, können Sie den Diagrammtyp ändern, indem Sie die type-Eigenschaft der config-Eigenschaft aktualisieren.

Jeder von der type-Eigenschaft akzeptierte Wert wird einer bestimmten React-Komponente zugeordnet. Wenn also type auf line gesetzt ist, wird eine Line-Komponente gerendert. Wenn type auf area gesetzt ist, wird eine Area-Komponente gerendert usw.

Mit der Eigenschaft chartTypeMap der Komponente Visualization können Sie der Zuordnungstabelle für Typ und Komponente einen neuen Eintrag hinzufügen oder vorhandene Einträge ersetzen, die jedem type-Wert eine bestimmte Komponente zuordnen.

Voraussetzungen

Zuerst müssen Sie die DataProvider-Komponente importieren und eine authentifizierte SDK-Instanz angeben. Das folgende Beispiel wurde im Looker-Erweiterungsframework erstellt und das SDK stammt von ExtensionContext.

Innerhalb von DataProvider können Sie die Komponenten Query und Visualization rendern, um Daten vom Looker SDK anzufordern und die erwartete Visualisierung in Ihrer Anwendung zu rendern.

Die Einrichtung erfolgt so: Ersetzen Sie in der Property „query“ den Wert durch den Query.client_id aus Ihrer Abfrage:

import React, { useContext } from 'react'
import { ExtensionContext } from '@looker/extension-sdk-react'
import { DataProvider } from '@looker/components-data'
import { Query, Visualization } from '@looker/visualizations'

const App = () => {
    const { core40SDK } = useContext(ExtensionContext)
    return (
        <DataProvider sdk={core40SDK}>
            <Query query="z8klgi4PJKAl7TXgTw1opS">
                <Visualization />
            </Query>
        </DataProvider>
    )
}

Neuen Diagrammtyp hinzufügen

Sie können den gerenderten Diagrammtyp ändern, indem Sie der Query-Komponente eine Konfigurationsüberschreibung übergeben.

<Query query="z8klgi4PJKAl7TXgTw1opS" config={{ type: 'pie' }}>
    <Visualization />
</Query>

In diesem Fall wurde type auf pie festgelegt, ein Diagramm, das in Looker-Komponenten standardmäßig angeboten wird. Was aber, wenn Sie ein Diagramm verwenden möchten, das nicht standardmäßig angeboten wird? In diesem Fall können Sie die Eigenschaft chartTypeMap von Visualization verwenden, um die Diagrammkomponenten in der Typ-/Komponentenzuordnung im Adaptersystem hinzuzufügen oder zu ersetzen.

Wenn Sie beispielsweise der Typ-/Komponentenkarte ein neues Radardiagramm hinzufügen möchten, fügen Sie es so dem chartTypeMap hinzu:

import React, { useContext } from 'react'
import { ExtensionContext } from '@looker/extension-sdk-react'
import { DataProvider } from '@looker/components-data'
import { Query, Visualization } from '@looker/visualizations'
import { MyCustomRadar } from '../MyCustomRadar'

const App = () => {
    const { core40SDK } = useContext(ExtensionContext)
    return (
        <DataProvider sdk={core40SDK}>
            <Query query="z8klgi4PJKAl7TXgTw1opS" config={{ type: 'radar'}}>
                <Visualization chartTypeMap={{ radar: MyCustomRadar }} />
            </Query>
        </DataProvider>
    )
}

Dieser Code führt Folgendes aus:

  • Importiert die React-Komponente MyCustomRadar
  • Die Property config.type wird der Property radar zugewiesen.
  • Aktualisiert die Property chartTypeMap, damit das Typzuordnungssystem weiß, was für eine type von radar gerendert werden soll.

So wird sie im Looker-Visualisierungs-Playground gerendert:

Im Visualisierungs-Lab wird eine Radarkarte angezeigt.

Ebenso können Sie vorhandene Diagramme ersetzen, wenn Sie eine eigene Version rendern möchten. Im folgenden Beispiel wird das Liniendiagramm der Standard-Looker-Komponenten durch eine benutzerdefinierte Liniendiagrammkomponente überschrieben:

import React, { useContext } from 'react'
import { ExtensionContext } from '@looker/extension-sdk-react'
import { DataProvider } from '@looker/components-data'
import { Query, Visualization } from '@looker/visualizations'
import { MyCustomLine } from '../MyCustomLine'

const App = () => {
    const { core40SDK } = useContext(ExtensionContext)
    return (
        <DataProvider sdk={core40SDK}>
            <Query query="z8klgi4PJKAl7TXgTw1opS">
                <Visualization chartTypeMap={{ line: MyCustomLine }} />
            </Query>
        </DataProvider>
    )
}

Wenn die Query-Komponente nun auf eine Abfrage stößt, bei der der Visualisierungstyp auf line festgelegt ist, wird die benutzerdefinierte Implementierung anstelle der Looker-Standardeinstellung gerendert.

Nächste Schritte