Gebäudekachel-Erweiterungen

Ab Looker 24.0 können Erweiterungen so entwickelt werden, dass sie in einem Tile in Dashboards ausgeführt werden. Erweiterungen, die als Tile oder Visualisierung ausgeführt werden können, können hinzugefügt werden, während sich das Dashboard im Bearbeitungsmodus befindet. Sie können auch als Visualisierung aus einem Explore in einem Dashboard gespeichert werden. Erweiterungen können auch als Tiles in LookML-Dashboards konfiguriert werden.

Beispiele für Erweiterungen, die als Dashboard-Tiles verwendet werden können, sind verfügbar:

• Die Erweiterung für die Tile-Visualisierung zeigt, wie Sie mit dem Erweiterungs-Framework eine benutzerdefinierte Visualisierung erstellen.
• Die Erweiterung für das Tile-SDK zeigt die verfügbaren API-Methoden, die speziell für Tile-Erweiterungen gelten.

Looker Extension SDK mit Tile-Erweiterungen verwenden

Für Tile-Erweiterungen muss der mount_points Parameter in der Manifestdatei des LookML-Projekts definiert sein, damit Erweiterungen als Tiles in ein Dashboard geladen werden können. Es gibt zwei Arten von mount_points für Tile-Erweiterungen:

  mount_points: {
    dashboard_vis: yes
    dashboard_tile: yes
    standalone: yes
  }

• dashboard_vis — Wenn diese Option aktiviert ist, wird die Erweiterung in den Visualisierungsoptionen eines Explore angezeigt. Dort kann sie als Visualisierung ausgewählt und als Dashboard-Tile gespeichert werden. Wenn das Dashboard ausgeführt wird, wird die mit dem Tile verknüpfte Abfrage ausgeführt und die Daten werden der Erweiterung zur Verfügung gestellt. Das funktioniert ähnlich wie bei benutzerdefinierten Visualisierungen. Der Hauptunterschied zwischen einer benutzerdefinierten Visualisierung und einer Erweiterung, die in einem Dashboard-Tile mit aktivierter Option dashboard_vis ausgeführt wird, besteht darin, dass die Erweiterung Looker API-Aufrufe ausführen kann.
• dashboard_tile — Wenn diese Option aktiviert ist, wird die Erweiterung im Erweiterungen Bereich angezeigt, der eingeblendet wird, wenn ein Nutzer ein Dashboard bearbeitet und nach dem Klicken auf die Schaltbare Hinzufügen die Option Erweiterungen auswählt. Diese Art von Erweiterung ruft ihre eigenen Daten ab, anstatt dass die Tile-Abfrage die Erweiterung automatisch mit Daten versorgt.

Ein zusätzlicher Bereitstellungspunkt, standalone, bewirkt, dass die Erweiterung im Hauptmenü von Looker unter Anwendungen angezeigt wird. Für eine Erweiterung können mehrere Mount-Points definiert sein. Zur Laufzeit wird die Erweiterung darüber informiert, wie sie eingebunden ist, und sie kann ihr Verhalten entsprechend anpassen. Beispielsweise müssen standalone Erweiterungen ihre eigene Höhe festlegen, Tile-Erweiterungen jedoch nicht.

Zusätzliche APIs für Tile-Erweiterungen

Tile-Erweiterungen werden zur Laufzeit mit zusätzlichen APIs und Daten bereitgestellt. Diese werden aus dem Erweiterungskontext abgerufen:

const {
  tileSDK,
  tileHostData,
  visualizationData,
  visualizationSDK,
} = useContext(ExtensionContext40)

• tileSDK: Bietet Tile-spezifische Funktionen, mit denen die Erweiterung mit dem Looker-Dashboard-Host interagieren kann. Beispielsweise kann die Erweiterung so Fehlermeldungen anzeigen und löschen.
• tileHostData: Stellt der Erweiterung Tile-Daten zur Verfügung. Die Daten werden automatisch basierend auf Interaktionen mit dem Hosting-Dashboard aktualisiert. Ein Beispiel ist der Indikator isDashboardEditing.
• visualizationSDK: Bietet Visualisierungs-spezifische Funktionen, mit denen die Erweiterung mit dem Looker-Dashboard-Host interagieren kann. Ein Beispiel ist die Funktion updateRowLimit.
• visualizationData: Stellt der Erweiterung Visualisierungsdaten zur Verfügung. Die Daten werden automatisch basierend auf Interaktionen mit dem Hosting-Dashboard aktualisiert. Die Daten ähneln den Daten, die für benutzerdefinierte Visualisierungen bereitgestellt werden.

Reaktive Erweiterungen erstellen

Die IFrames, in denen Erweiterungen ausgeführt werden, werden automatisch angepasst, wenn die Größe des übergeordneten Looker-Hostfensters geändert wird. Dies wird automatisch im Fenster mit den IFrame-Inhalten widergespiegelt. Die IFrame-Komponente hat keinen Innen- oder Außenabstand. Daher muss die Erweiterung ihren eigenen Innen- und Außenabstand bereitstellen, damit sie mit der Looker-Anwendung übereinstimmt. Bei eigenständigen Erweiterungen muss die Erweiterung die Höhe selbst steuern. Bei Erweiterungen, die in Dashboard-Tiles oder Explore-Visualisierungen ausgeführt werden, wird die Höhe des Fensters mit den IFrame-Inhalten automatisch auf die Höhe festgelegt, die vom IFrame zur Verfügung gestellt wird.

Überlegungen zum Rendering

Tile-Erweiterungen werden gerendert, wenn ein Dashboard als PDF oder Bild heruntergeladen wird. Der Renderer erwartet, dass das Tile ihn benachrichtigt, wenn das Rendering abgeschlossen ist. Wenn dies nicht geschieht, reagiert der Renderer nicht mehr. Im Folgenden sehen Sie ein Beispiel dafür, wie Sie den Renderer benachrichtigen, dass das Tile gerendert wurde.

  const { extensionSDK } = useContext(ExtensionContext40)

  useEffect(() => {
    extensionSDK.rendered()
  }, [])

Animationen sollten beim Rendering ebenfalls deaktiviert werden. Im folgenden Beispiel werden die Animationskonfigurationen beim Rendering deaktiviert:

  const { lookerHostData} = useContext(ExtensionContext40)
  const isRendering = lookerHostData?.isRendering

  const config = isRendering
    ? {
        ...visConfig,
        valueCountUp: false,
        waveAnimateTime: 0,
        waveRiseTime: 0,
        waveAnimate: false,
        waveRise: false,
      }
    : visConfig

  if (mountPoint === MountPoint.dashboardVisualization) {
    return <VisualizationTile config={config} />
  }

Funktionen und Attribute des Tile-SDK

Das Tile-SDK bietet Funktionen, mit denen eine Tile-Erweiterung mit dem Hosting-Dashboard interagieren kann.

Die verfügbaren Funktionen und Attribute sind in der folgenden Tabelle aufgeführt:

Tile-SDK-Daten

Die verfügbaren Attribute für Tile-SDK-Daten sind in der folgenden Tabelle aufgeführt:

Funktionen und Attribute des Visualisierungs-SDK

Die verfügbaren Funktionen und Attribute des Visualisierungs-SDK sind in der folgenden Tabelle aufgeführt:

Visualisierungs-SDK-Daten

Das Visualisierungs-SDK besteht aus folgenden Komponenten:

• Visualisierungskonfigurationsdaten
• Daten zur Abfrageantwort

Visualisierungskonfigurationsdaten

export interface VisualizationConfig {
  queryFieldMeasures: Measure[]
  queryFieldDimensions: Dimension[]
  queryFieldTableCalculations: TableCalculation[]
  queryFieldPivots: PivotConfig[]
  visConfig: RawVisConfig
}

Daten zur Abfrageantwort

Embed SDK verwenden

Die Verwendung des Embed SDK in einer Tile-Erweiterung wird aus folgenden Gründen nicht empfohlen:

• Es ist möglich, dass die Erweiterung ein Dashboard rendert, in dem die Erweiterung ein Tile ist. Das Erweiterungs-Framework kann dies nicht erkennen und der Browser kann abstürzen.
• Das PDF-Rendering von eingebetteten Inhalten in einer Tile-Erweiterung funktioniert nicht.