Entwicklung einer benutzerdefinierten Visualisierung für den Looker Marketplace

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 eine benutzerdefinierte Visualisierung direkt in Ihrem Projekt erstellen, ohne sie anderen Looker-Kunden zur Verfügung zu stellen.

Bitte beachten Sie, dass Sie Mitglied des Looker-Partnernetzwerks oder Looker-Kunde sein müssen, um Inhalte an den Looker Marketplace senden zu können.

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

Wenn die Looker-Funktion Marketplace aktiviert ist, können Looker-Kunden Looker Marketplace-Plug-ins installieren. Dazu gehören Visualisierungstypen, die der nativen Visualisierungsbibliothek von Looker hinzugefügt werden können.

Gehen Sie so vor, um eine benutzerdefinierte Visualisierung zu entwickeln und allen Looker-Kunden über den Looker Marketplace zur Verfügung zu stellen:

  1. Entwickeln Sie eine Visualisierung.
  2. Erstellen Sie ein Looker-Projekt für die Visualisierung.
  3. Übertragen Sie das Looker-Projekt in ein Git-Repository.
  4. Funktion der Visualisierung testen
  5. 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 im Marketplace oder als native Looker-Visualisierung aufgeführt ist.

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

Looker-Projekt für die Visualisierung erstellen

Erstellen Sie ein Looker-Projekt für Ihre benutzerdefinierte Visualisierung. Das Projekt sollte die folgenden Dateien enthalten:

  • LIZENZ-Datei: Listet die Lizenz oder Lizenzen auf, mit denen die Visualisierung verteilt wird, unter Verwendung des folgenden Textes:

    This Looker visualization is distributed with the following license:...

  • Datei README.md: Enthält eine Beschreibung Ihrer Visualisierung und ihrer Funktionsweise sowie zusätzliche Informationen.

  • JavaScript-Datei (.js): Enthält eine komprimierte Version des JavaScript-Codes, den Sie zum Erstellen der Visualisierung verwendet haben. Der Marketplace enthält auch JS-Dateien in das Projekt, was eine ordnungsgemäße Versionsverwaltung und Paketverwaltung ermöglicht.

  • Manifestdatei (manifest.lkml): Gibt eine id (eindeutige Kennung) und eine label (in der Looker-Benutzeroberfläche für diese Visualisierung angezeigt) 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 dafür, wie die Visualisierung im Marketplace angezeigt wird, den Speicherort der image_uri sowie eine Kurzinfo, in der der Anwendungsfall für die Visualisierung beschrieben wird. Außerdem werden die Marktplatz-Feldkonstanten definiert, 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 in Git übertragen

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

  1. Öffentlich zugängliches GitHub-Repository erstellen
  2. Setzen Sie die Repository-URL Ihres Looker-Projekts auf die URL Ihres GitHub-Repositorys.
  3. Folgen Sie den Git-Aufforderungen in Looker, um Ihren Code zu validieren, per Commit zu übertragen und für die Produktion bereitzustellen.

Funktionalität der Visualisierung testen

Testen Sie die neue Visualisierung, indem Sie sie auf einen geeigneten Explore oder Look in Ihrer Looker-Instanz anwenden:

  1. Navigieren Sie zum Look oder Explore.
  2. Klicken Sie in einem Look auf Bearbeiten, um den Look zu bearbeiten.
  3. Klicken Sie im Menü der Visualisierungstypen auf das Dreipunkt-Menü, um die Drop-down-Liste mit den Visualisierungen zu öffnen.
  4. Wählen Sie Ihre benutzerdefinierte Visualisierung aus.
  5. Klicken Sie auf Speichern, um die Änderung am Look zu speichern. Notieren Sie sich alle Dashboards, die von dieser Änderung betroffen sein könnten.

Looker benötigt diese Funktionen in den Visualisierungen, die im Looker Marketplace verfügbar sind:

Funktion Erforderlich
Unterstützung für Aufschlüsselungen in Visualisierungen Ja
Möglichkeit, die Farbpaletten von Looker zu übernehmen Ja
Anwendbarkeit auf Browser und Bildschirmgröße Ja
Einheitliche Schriftfamilie: font-family: Helvetica, Arial, sans-serif Ja
Schriftgröße Ja
Im Konfigurationsbereich der Visualisierung können Wertelabels und Achsenlabels ein- und ausgeschaltet werden. Ja
Visualisierung von Pivot-Daten Ja (falls zutreffend)
Visualisierung wird basierend auf Nutzerinteraktion aktualisiert. Verwenden Sie dazu die Funktion updateAsync oder is update function Ja
Eindeutige Fehlermeldungen (z. B. Diese Visualisierung erfordert 1 Dimension und 2 Kennzahlen) Ja
Durch alle Optionen im Konfigurationsbereich für die Visualisierung wird eine offensichtliche Änderung an der Visualisierung vorgenommen Ja
Standardmäßig wird die value-Formatierung des Felds verwendet Ja (falls zutreffend)
Wenn eine Abfrage keine Ergebnisse zurückgibt, wird ein Fehler ausgegeben Ja

Visualisierung zur Überprüfung einreichen

Sobald Ihre Visualisierung zur Einreichung bereit ist, folgen Sie der Anleitung unter Inhalte beim Looker Marketplace einreichen, um unterstützende Dokumentation für Ihre Visualisierung zu erstellen. Senden Sie Ihre Visualisierung dann zur Überprüfung an das Looker-Team und veröffentlichen Sie die Visualisierung im Looker Marketplace.