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 werden kann und auf den andere Looker-Nutzer zugreifen können. Sie können auch direkt in Ihrem Projekt eine benutzerdefinierte Visualisierung erstellen, ohne sie anderen Looker-Kunden zur Verfügung zu stellen.

Hinweis: Sie müssen Mitglied des Looker-Partnernetzwerks oder Looker-Kunden sein, um Inhalte an den Looker Marketplace senden zu können.

Der Looker Marketplace ist ein zentraler Ort, an dem Sie viele Arten von Looker-Inhalten finden, bereitstellen und verwalten können, z. B. Looker BlocksTM, Anwendungen, Visualisierungen und andere Plug-ins.

Wenn die Looker-Funktion für den Marketplace aktiviert ist, können Looker-Kunden Looker Marketplace-Plug-ins installieren. Diese enthalten Visualisierungstypen, die in die native Visualisierungsbibliothek von Looker aufgenommen werden können.

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

  1. Entwickeln Sie eine Visualisierung.
  2. Erstellen Sie ein Looker-Projekt für die Visualisierung.
  3. Übertragen Sie das Looker-Projekt an ein Git-Repository.
  4. Funktion der Visualisierung testen
  5. Visualisierung an Looker senden

Visualisierungstyp entwickeln

Wählen Sie den 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 mit der Looker Visualization API mit 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:

  • LIZENZ-Datei: Gibt die Lizenz oder Lizenzen an, mit denen die Visualisierung vertrieben wird, mit dem Text
    „Diese Looker-Visualisierung wird mit der folgenden Lizenz bereitgestellt:...“.

  • README.md-Datei: Liefert 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. Im Marketplace sind JS-Dateien enthalten, die eine korrekte Versionsverwaltung und Paketverwaltung ermöglichen.

  • Manifestdatei (manifest.lkml): Gibt eine id (eine eindeutige Kennung) und eine label (in der Looker-Benutzeroberfläche 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 der Visualisierung im Marketplace, den Speicherort von image_uri, eine Kurzbeschreibung für den Anwendungsfall für die Visualisierung sowie die Definition der Konstanten in den Marketplace-Feldern, 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 übertragen

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

  1. Erstellen Sie ein öffentlich zugängliches GitHub-Repository.
  2. Legen Sie die Repository-URL des Looker-Projekts auf die URL Ihres GitHub-Repositorys fest.
  3. Folgen Sie den Git-Aufforderungen in Looker, um Ihren Code zu validieren, per Commit zu übernehmen und in der Produktionsumgebung bereitzustellen.

Funktion der Visualisierung testen

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

  1. Rufen Sie „Ansehen“ oder „Erkunden“ auf.
  2. Wenn Sie einen Look aufrufen, klicken Sie auf Bearbeiten.
  3. Klicken Sie im Menü „Visualisierungstyp“ auf das Dreipunkt-Menü, um die Drop-down-Liste zu öffnen.
  4. Wählen Sie die benutzerdefinierte Visualisierung aus.
  5. Klicken Sie auf Speichern, um die Änderung im Looker zu speichern. Beachten Sie alle Dashboards, die von dieser Änderung betroffen sein könnten.

Für Looker sind die folgenden Funktionen in den Visualisierungen erforderlich, die im Looker Marketplace verfügbar sind:

Funktion Erforderlich
Unterstützung für Aufschlüsselung nach Visualisierung Ja
Möglichkeit, die Farbpaletten von Looker zu übernehmen Ja
Reaktion auf Browser- und Bildschirmgröße Ja
Beständige Schriftfamilie: font-family: Helvetica, Arial, sans-serif Ja
Schriftgröße anpassen Ja
Ein-/Aus-Schaltfläche für Wertlabels und Achsenlabels im Steuerfeld zur Visualisierungskonfiguration Ja
Visualisierung von Pivot-Daten Ja (falls zutreffend)
Visualisierungsupdates auf Grundlage der Nutzerinteraktion mithilfe der updateAsync-Funktion oder is update function Ja
Löschen Sie die Fehlermeldungen (z. B. Diese Visualisierung erfordert eine Dimension und zwei Messwerte). Ja
Alle Optionen im Konfigurationsbereich der Visualisierung wirken sich offensichtlich auf die Visualisierung aus Ja
Standardmäßig die value-Formatierung des Felds verwenden Ja (falls zutreffend)
Ein Fehler wird ausgegeben, wenn eine Abfrage keine Ergebnisse zurückgibt Ja

Visualisierung zur Überprüfung einreichen

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