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.

Sie müssen Mitglied des Looker Partner Networks oder Looker-Kunde sein, um Inhalte im Looker Marketplace einreichen 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, die Visualisierungstypen enthalten, die der nativen Visualisierungsbibliothek von Looker hinzugefügt werden können.

So entwickeln Sie eine benutzerdefinierte Visualisierung und stellen sie allen Looker-Kunden über den Looker Marketplace zur Verfügung:

  1. Entwickeln Sie eine Visualisierung.
  2. Erstellen Sie ein Looker-Projekt für die Visualisierung.
  3. Pushen Sie das Looker-Projekt in ein Git-Repository.
  4. Funktionieren der Visualisierung testen
  5. Ihre Visualisierung an Looker senden

Visualisierungstyp entwickeln

Wählen Sie eine Visualisierungsart aus, die 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 in 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 bzw. Lizenzen auf, mit denen die Visualisierung verbreitet wird. Der Text lautet:

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

  • Datei README.md: Enthält eine Beschreibung der Visualisierung, ihre Funktionsweise und zusätzliche Informationen.

  • JavaScript-Datei (.js): Enthält eine komprimierte Version des JavaScript-Codes, mit dem Sie die Visualisierung erstellt haben. Im Marketplace sind JS-Dateien im Projekt enthalten, was eine ordnungsgemäße Versionsverwaltung und Paketverwaltung ermöglicht.

  • Manifestdatei (manifest.lkml): Gibt eine id (eine eindeutige Kennung) und eine label (die in der Looker-Benutzeroberfläche für diese Visualisierung angezeigt wird) 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 des image_uri, einen Slogan, in dem der Anwendungsfall der Visualisierung beschrieben wird, und definiert auch die Marketplace-Feldkonstanten, die 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 per Push an Git übertragen

Hosten Sie die LookML-Datei Ihrer Visualisierung 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. Legen Sie die Repository-URL Ihres Looker-Projekts auf die URL Ihres GitHub-Repositorys fest.
  3. Folgen Sie der Git-Anleitung in Looker, um Ihren Code zu validieren, zu committen und in der Produktion bereitzustellen.

Funktionalität der Visualisierung testen

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

  1. Rufen Sie den Look oder das Explore auf.
  2. Wenn Sie einen Look aktiviert haben, klicken Sie auf Bearbeiten, um ihn zu bearbeiten.
  3. Klicken Sie im Menü „Visualisierungstyp“ auf das Dreipunkt-Menü, um die Drop-down-Liste mit Visualisierungen zu öffnen.
  4. Wählen Sie die 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 folgende Funktionen in den im Looker Marketplace verfügbaren Visualisierungen:

Funktion Erforderlich
Unterstützung für Drilldown-Vorgänge in Visualisierungen Ja
Möglichkeit, die Farbpaletten von Looker zu übernehmen Ja
Reaktionsfähigkeit an Browser und Bildschirmgröße Ja
Einheitliche Schriftfamilie: font-family: Helvetica, Arial, sans-serif Ja
Schriftgröße Ja
Im Konfigurationsbereich der Visualisierung können Sie zwischen Wertlabels und Achsenlabels wechseln. Ja
Visualisierung von Pivot-Daten Ja (falls zutreffend)
Die Visualisierung wird basierend auf der Nutzerinteraktion mit der updateAsync-Funktion oder is update function aktualisiert. Ja
Fehlermeldungen werden gelöscht (z. B. Für diese Visualisierung sind eine Dimension und zwei Messwerte erforderlich). Ja
Bei allen Optionen im Konfigurationskonfigurationsbereich der Visualisierung wird eine sichtbare Änderung an der Visualisierung vorgenommen Ja
Standardmäßig die value-Formatierung des Felds verwenden Ja (falls zutreffend)
Fehler wird geworfen, wenn eine Abfrage keine Ergebnisse zurückgibt Ja

Visualisierung zur Überprüfung einreichen

Sobald Ihre Visualisierung zur Übermittlung bereit ist, folgen Sie der Anleitung unter Inhalte an den Looker Marketplace senden, um eine unterstützende Dokumentation für Ihre Visualisierung zu erstellen, Ihre Visualisierung zur Überprüfung an das Looker-Team zu senden und Ihre Visualisierung im Looker Marketplace zu veröffentlichen.