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 verwendet werden kann. Sie können auch eine benutzerdefinierte Visualisierung direkt in Ihrem Projekt erstellen, ohne sie für andere Looker-Kunden verfügbar zu machen.

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, an dem Sie viele Arten von Looker-Inhalten wie Looker Blocks™, Anwendungen, Visualisierungen und andere Plug-ins suchen, bereitstellen und verwalten können.

Wenn die Funktion Looker Marketplace aktiviert ist, können Looker-Kunden Looker Marketplace-Plug-ins installieren. Diese enthalten Visualisierungstypen, 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. Funktionen der Visualisierung testen
  5. Reichen Sie die Visualisierung in Looker ein.

Visualisierungstyp entwickeln

Legen Sie einen Visualisierungstyp fest, den Sie entwickeln möchten. Prüfen Sie, ob diese Visualisierung bereits im Marketplace oder als native Looker-Visualisierung aufgeführt ist.

Erstellen Sie Ihre benutzerdefinierte Visualisierung in JavaScript mit der Looker Visualization 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:

  • LICENSE-Datei: Listet die Lizenz oder Lizenzen auf, unter denen die Visualisierung vertrieben wird. Dazu wird der folgende Text verwendet:

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

  • README.md-Datei: Enthält eine Beschreibung Ihrer Visualisierung, wie sie funktioniert, und weitere 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 Versions- 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: []
    }
  • Marketplace-Eintragsdatei (marketplace.json): Hiermit wird der Marketplace-Eintrag für die benutzerdefinierte Visualisierung konfiguriert. Sie enthält ein Label für die Darstellung der Visualisierung im Marketplace, den Speicherort der image_uri, einen Slogan, der den Anwendungsfall für die Visualisierung beschreibt, sowie die Marketplace-Feldkonstanten, die Nutzer bei 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 pushen

Hosten Sie die LookML-Datei Ihrer Visualisierung in einem öffentlich zugänglichen GitHub-Repository. Angenommen, Sie haben die Visualisierung in einem Looker-Projekt erstellt, gehen Sie so vor, um sie in ein neues Repository zu pushen:

  1. Erstellen Sie ein öffentlich zugängliches GitHub-Repository.
  2. Legen Sie die Repository-URL Ihres Looker-Projekts auf die URL Ihres GitHub-Repositories 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 in Ihrer Looker-Instanz anwenden:

  1. Rufen Sie den Look oder das Explore auf.
  2. Wenn du einen Look bearbeiten möchtest, klicke auf Bearbeiten.
  3. Klicken Sie im Menü für den Visualisierungstyp auf das Dreipunkt-Menü, um das Drop-down-Menü mit den Visualisierungen zu öffnen.
  4. Wählen Sie die benutzerdefinierte Visualisierung aus.
  5. Klicke auf Speichern, um die Änderung am Look zu speichern. Notieren Sie sich alle Dashboards, die von dieser Änderung betroffen sein könnten.

Für die Visualisierungen im Looker Marketplace sind die folgenden Funktionen erforderlich:

Funktion Erforderlich
Unterstützung für die Aufschlüsselung von Visualisierungen Ja
Möglichkeit, die Farbpaletten von Looker zu übernehmen Ja
Responsives Design für Browser und Bildschirmgröße Ja
Einheitliche Schriftfamilie: font-family: Helvetica, Arial, sans-serif Ja
Schriftgröße Ja
Möglichkeit, Wertbeschriftungen und Achsenbeschriftungen im Konfigurationsbereich der Visualisierung ein- und auszublenden Ja
Visualisierung von Pivot-Daten Ja (falls zutreffend)
Aktualisierung der Visualisierung basierend auf der Nutzerinteraktivität mithilfe der Funktion updateAsync oder is update function Ja
Fehlermeldungen löschen (z. B. Für diese Visualisierung sind eine Dimension und zwei Messwerte erforderlich) Ja
Alle Optionen im Konfigurationsbereich für Visualisierungen führen zu einer offensichtlichen Änderung der Visualisierung. Ja
Standardmäßig wird die value-Formatierung des Felds verwendet. Ja (falls zutreffend)
Fehler wird geworfen, wenn eine Abfrage keine Ergebnisse zurückgibt Ja

Visualisierung zur Überprüfung einreichen

Sobald Ihre Visualisierung zur Einreichung bereit ist, folgen Sie der Anleitung unter Inhalte im Looker Marketplace einreichen, um ergänzende Dokumente für Ihre Visualisierung zu erstellen, Ihre Visualisierung zur Überprüfung an das Looker-Team zu senden und sie im Looker Marketplace zu veröffentlichen.