Benutzerdefinierte Visualisierung für den Looker Marketplace entwickeln

Auf dieser Seite wird beschrieben, wie Sie einen benutzerdefinierten Visualisierungstyp erstellen, der dem Looker Marketplace hinzugefügt und von anderen Looker-Nutzern aufgerufen werden kann. Sie können auch direkt in Ihrem Projekt eine benutzerdefinierte Visualisierung erstellen, ohne sie anderen Looker-Kunden zur Verfügung zu stellen.

Beachten Sie, dass Sie ein Mitglied des Looker-Partnernetzwerks sein müssen oder ein Looker-Kunde sein müssen, um Inhalte auf dem Looker Marketplace einreichen zu können.

Der Looker Marketplace ist ein zentraler Ort zum Suchen, Bereitstellen und Verwalten vieler Arten von Looker-Inhalten, z. B. Looker BlocksTM, Anwendungen, Visualisierungen und anderen Plug-ins.

Wenn die Marketplace-Funktion von Looker aktiviert ist, können Looker-Kunden Looker Marketplace-Plug-ins installieren, die Visualisierungstypen enthalten, die der nativen Visualisierungsbibliothek von Looker hinzugefügt werden können. Visualisierungen, die über den Marketplace installiert werden, werden vom Looker-Team unterstützt.

So erstellen Sie eine benutzerdefinierte Visualisierung und machen sie für alle Looker-Kunden über den Looker Marketplace verfügbar:

Erstellen Sie eine Visualisierung.
Erstellen Sie ein Looker-Projekt für die Visualisierung.
Übertragen Sie das Looker-Projekt an ein Git-Repository.
Funktion der Visualisierung testen
Senden Sie Ihre Visualisierung an Looker.

Visualisierungstyp entwickeln

Wählen Sie einen Visualisierungstyp aus, den Sie entwickeln möchten. Achten Sie darauf, dass diese Visualisierung nicht bereits auf dem Marktplatz oder als native Looker-Visualisierung aufgeführt ist.

Entwickeln Sie Ihre benutzerdefinierte Visualisierung in JavaScript mithilfe der Looker Visualizer API in Ihrer JavaScript-Umgebung.

Looker-Projekt für die Visualisierung erstellen

Erstellen Sie ein Looker-Projekt, um Ihre benutzerdefinierte Visualisierung darzustellen. Das Projekt sollte die folgenden Dateien enthalten:

LIZENZdatei: Listet die Lizenz oder Lizenzen mit der Visualisierung im Text
auf. Diese Looker-Visualisierung wird mit der folgenden Lizenz bereitgestellt:...".
Datei README.md: Enthält eine Beschreibung der Visualisierung, ihrer Funktionsweise und zusätzliche Informationen.
JavaScript-Datei (.js): Enthält eine komprimierte Version des JavaScript-Codes, den Sie zum Erstellen der Visualisierung verwendet haben. Auf dem Marktplatz sind JS-Dateien enthalten, die eine ordnungsgemäße Versionsverwaltung und Paketverwaltung ermöglichen.
Manifestdatei (manifest.lkml): Gibt eine id (eine eindeutige Kennung) und eine label (in der Looker-UI für diese Visualisierung an) Beispiel:

    constant: vis_id {
        value: "default_id"
        export: override_optional
    }
    constant: vis_label {
        value: "default_label"
        export: override_optional
    }
    visualization: {
        id: "@{vis_id}"
        label: "@{vis_label}"
        file: "my_local.js"
        sri_hash: "my_sri_hash"
        dependencies: []
    }

Eintragsdatei (marketplace.json): Konfiguriert den Marketplace-Eintrag für die benutzerdefinierte Visualisierung und enthält ein Label für die Darstellung auf dem Marktplatz, die Position von image_uri, eine Kurzinfo, die den Anwendungsfall für die Visualisierung beschreibt, sowie die Marketplace-Feldkonstanten, die Nutzer während der Installation eingeben. Beispiel:

{
  "label": "Gauge Visualization",
  "category_label": "plug-ins",
  "branding": {
    "image_uri": "https://marketplace-api.looker.com/visualization-screenshots/gauge_icon.png",
    "tagline": "Use the Gauge visualization to display a measure and progress to a goal."
  },
   "constants": {
        "vis_label": {
            "label": "Visualization Label",
            "description": "This label will appear in the visualization selector in the Looker Explore UI."
        },
        "vis_id": {
            "label": "Visualization Id",
            "description": "This must be a unique ID across all visualizations.",
            "value_constraint": "visualization"
        }
    }
}

Projekt an Git senden

Hosten Sie Ihre Visualisierungs-LookML in einem öffentlich zugänglichen GitHub-Repository. Wenn Sie die Visualisierung in einem Looker-Projekt erstellt haben, gehen Sie so vor, um sie in ein neues Repository zu übertragen:

Erstellen Sie ein öffentlich zugängliches GitHub-Repository.
Legen Sie die Repository-URL des Looker-Projekts auf die URL Ihres GitHub-Repositorys fest.
Folgen Sie den Git-Aufforderungen in Looker, um Ihren Code zu validieren, per Commit zu übergeben und für die Produktion bereitzustellen.

Visualisierungsfunktionen testen

Testen Sie die neue Visualisierung, indem Sie sie auf eine passende Explore- oder Look-Instanz auf Ihrer Looker-Instanz anwenden:

Rufen Sie „Ansehen“ oder „Erkunden“ auf.
Klicken Sie bei einem Look auf Bearbeiten, um ihn zu bearbeiten.
Klicken Sie im Menü mit den Visualisierungstypen auf das Dreipunkt-Menü, um die Drop-down-Liste mit Visualisierungen zu öffnen.
Wählen Sie die benutzerdefinierte Visualisierung aus.
Klicken Sie auf Speichern, um die Änderung am Look zu speichern. Beachten Sie alle Dashboards, die von dieser Änderung betroffen sein könnten.

Looker erfordert die folgenden Funktionen in den Visualisierungen, die über den Looker Marketplace verfügbar sind:

Funktion	Erforderlich
Unterstützung für die Aufschlüsselung der Visualisierung	Ja
Möglichkeit, die Farbvorlagen von Looker zu übernehmen	Ja
Sensibilität für Browser und Bildschirmgröße	Ja
Konsistente Schriftfamilie: `font-family`: `Helvetica`, `Arial`, `sans-serif`	Ja
Schriftgröße	Ja
Ein-/Aus-Schaltfläche für Wert-Labels und Achsenlabels im Konfigurationsbereich	Ja
Visualisierung von Daten mit Pivoting	Ja (falls zutreffend)
Visualisierungsaktualisierungen basierend auf Nutzerinteraktion mithilfe der Funktion `updateAsync` oder `is update function`	Ja
Löschen Sie Fehlermeldungen (z. B. Diese Visualisierung erfordert 1 Dimension und 2 Messwerte).	Ja
Bei allen Optionen im Konfigurationsbereich für die Visualisierung wird die Visualisierung sichtbar.	Ja
Standardmäßig die `value`-Formatierung des Felds verwenden	Ja (falls zutreffend)
Wenn eine Abfrage keine Ergebnisse liefert, wird ein Fehler ausgegeben	Ja

Visualisierung zur Überprüfung einreichen

Sobald die Visualisierung fertig ist, folgen Sie der Anleitung unter Inhalte an den Looker Marketplace senden, um entsprechende Visualisierungen für Ihre Visualisierung zu erstellen. Reichen Sie Ihre Visualisierung dann zur Überprüfung durch das Looker-Team ein und veröffentlichen Sie die Visualisierung im Looker Marketplace.