Schaltflächenparameter für LookML-Dashboards

Schaltflächen werden nur von LookML-Dashboards mit den folgenden Einstellungen unterstützt:

Auf dieser Seite wird gezeigt, wie Sie ein LookML-Dashboard-Element vom Typ type: button mit LookML-Dashboard-Parametern in einer dashboard.lkml-Datei hinzufügen und anpassen. Mit Schaltflächen können Sie Links in Ihre Dashboards einfügen. Sie können Links zu Looker-Inhalten wie Looks und Dashboards oder zu anderen Websites einfügen.

Informationen zum Hinzufügen von Schaltflächen zu einem Dashboard über die Looker-Benutzeroberfläche finden Sie auf der Dokumentationsseite Benutzerdefinierte Dashboards erstellen.

Nutzungsbeispiel


## BASIC PARAMETERS
type: button
name: text
height: N
width: N
row: N
col: N

## BUTTON PARAMETER
rich_content_json: '{
 "text": "button text",
 "description": "description",
 "newTab": true | false,
 "alignment": "left" | "right" | "center",
 "size": "small" | "medium" | "large",
 "style": "OUTLINED" | "FILLED" | "TRANSPARENT",
 "color": "hex string or css color",
 "href": "link"
 }'

Parameterdefinitionen

Parametername Beschreibung
Grundlegende Parameter
type (für Elemente) Bestimmt den Visualisierungstyp, der im Element verwendet werden soll.
name (für Elemente) Erstellt ein Element
height (für Elemente) Definiert die Höhe des Kachelkästchens eines Schaltflächenelements. Die Höhe wird in Zeileneinheiten für layout: newspaper-Dashboards angegeben.
width (für Elemente) Definiert die Breite des Kachelkästchens eines Schaltflächenelements. Die Breite wird in Spalteneinheiten für layout: newspaper-Dashboards angegeben.
row Definiert die Position des Kachelkästchens eines Schaltflächenelements von oben nach unten in Zeileneinheiten für layout: newspaper-Dashboards.
col Definiert die Position der Kachelbox eines Schaltflächenelements von links nach rechts in Spalteneinheiten für layout: newspaper-Dashboards.
Schaltflächenparameter
rich_content_json Ein JSON-Objekt, das Schlüssel/Wert-Paare mit Informationen zur Schaltfläche enthält.

Grundlegende Parameter

Wenn Sie ein LookML-Dashboardelement vom Typ type: button definieren, müssen Sie mindestens Werte für die Parameter name und type angeben.

Die Parameter height, width, row und col beziehen sich auf die Kachelbox eines Schaltflächenelements und nicht auf die Schaltfläche selbst.

name

In diesem Abschnitt wird auf den Parameter name verwiesen, der Teil eines Dashboard-Elements ist.

name kann auch als Teil eines Dashboardfilters verwendet werden. Weitere Informationen finden Sie auf der Dokumentationsseite Dashboard-Parameter.

Mit jeder name-Deklaration wird ein neues Dashboard-Element erstellt und ihm ein Name zugewiesen. Elementnamen müssen eindeutig sein.

Die für den Button angegebene name wird nicht in der Dashboard-Benutzeroberfläche angezeigt.

- name: orders_by_date

type

In diesem Abschnitt wird auf den Parameter type verwiesen, der Teil eines Dashboard-Elements ist.

type kann auch als Teil eines Dashboardfilters verwendet werden. Weitere Informationen finden Sie auf der Dokumentationsseite Dashboard-Parameter.

type kann auch als Teil eines Joins verwendet werden. Dies wird auf der Dokumentationsseite zum Parameter type (für Joins) beschrieben.

type kann auch als Teil einer Dimension verwendet werden. Weitere Informationen finden Sie auf der Dokumentationsseite Dimensionen, Filter und Parametertypen.

type kann auch als Teil eines Messwerts verwendet werden. Weitere Informationen finden Sie auf der Dokumentationsseite Messwerttypen.

Der Parameter type bestimmt den Visualisierungstyp, der im Element verwendet werden soll.

- name: element_name
  type: text | looker_grid | table | single_value | looker_single_record |
        looker_column | looker_bar | looker_scatter | looker_line | looker_area |
        looker_pie | looker_donut_multiples | looker_funnel | looker_timeline |
        looker_map | looker_geo_coordinates | looker_geo_choropleth | looker_waterfall |
        looker_wordcloud | looker_boxplot | button

Eine Übersicht über die verschiedenen Arten von LookML-Dashboard-Elementen finden Sie auf der Dokumentationsseite type (für LookML-Dashboards).

height

In diesem Abschnitt wird auf den Parameter height verwiesen, der Teil eines Dashboard-Elements ist.

height kann auch als Teil einer Dashboard-Zeile verwendet werden. Weitere Informationen finden Sie auf der Dokumentationsseite Dashboard-Parameter.

Der Parameter height definiert die Höhe des Kachelkästchens eines Schaltflächenelements in Einheiten von Zeile.

Standardmäßig haben Tile-Felder für Button-Elemente eine Höhe von 6 Zeilen. Die Mindesthöhe beträgt 1 Zeile. Wenn Sie die Höhe des Schaltflächenelements ändern, kann sich das auf andere Elemente im Dashboard auswirken, nicht aber auf die Höhe der Schaltfläche selbst.

Mit dem folgenden Code wird beispielsweise die Höhe des Kachelkästchens der Schaltfläche auf 12 Zeilen festgelegt:

- dashboard: sales_overview
  layout: newspaper
  ...

  elements:
  - name: orders_by_date
    height: 12
    ...

width

In diesem Abschnitt wird auf den Parameter width verwiesen, der Teil eines Dashboard-Elements ist.

width kann auch als Teil eines Dashboards verwendet werden. Weitere Informationen finden Sie auf der Dokumentationsseite Dashboard-Parameter.

Der Parameter width definiert die Breite des Kachelkästchens eines Schaltflächenelements in Spalteneinheiten.

Die Breite des Tile-Felds eines Schaltflächenelements ist standardmäßig auf 8 Spalten festgelegt, was einem Drittel der Gesamtbreite eines Dashboards entspricht. Die Mindestbreite für das Kachelfeld einer Schaltfläche beträgt 2.

Mit dem folgenden Code wird beispielsweise die Kachelbox einer Schaltfläche auf die halbe Breite des Dashboards festgelegt:

- dashboard: sales_overview
  layout: newspaper
  ...

  elements:
  - name: orders_by_date
    width: 12
    ...

Wenn im Kachelfeld eines Buttons Platz ist, wird die Breite des Buttons erhöht, um einen langen Textstring aufzunehmen, der in text definiert ist. Die Breite der Schaltfläche wird jedoch nicht über den im Parameter width festgelegten Wert hinaus erhöht. Bei Bedarf wird der in text definierte String auf der Schaltfläche gekürzt.

row

Mit dem Parameter row wird die Zeile definiert, in der der obere Rand des Kachelkästchens eines Schaltflächenelements platziert wird.

Ein Dashboard beginnt mit Zeile 0 oben. Die Höhe von Dashboard-Schaltflächenelementen beträgt standardmäßig 6 Zeilen. Die Dashboard-Elemente oben auf einem Dashboard (row: 0) würden also standardmäßig die Zeilen 0 bis 5 einnehmen.

Im folgenden Beispiel wird die Kachelbox eines Buttons in die zweite Zeile der Elemente im Dashboard eingefügt, sofern die Elemente auf die Standardhöhe festgelegt sind:

- dashboard: sales_overview
  layout: newspaper
  ...

  elements:
  - name: orders_by_date
    row: 6
    ...

col

Der Parameter col definiert die Spalte, in der sich der linke Rand des Kachelkästchens des Schaltflächenelements befindet.

Dashboards sind in 24 Spalten unterteilt. Ein Dashboard beginnt mit Spalte 0 links im Dashboard. Bei einem Dashboard mit Zeitungs-Layout wird standardmäßig eine Elementbreite von 8 Spalten verwendet. Die Dashboard-Elemente auf der linken Seite eines Dashboards (col: 0) würden also standardmäßig die Spalten 0 bis 7 einnehmen.

Mit dem folgenden Code wird beispielsweise festgelegt, dass ein Element in der dritten Spalte der Elemente im Dashboard platziert werden soll:

- dashboard: sales_overview
  layout: newspaper
  ...

  elements:
  - name: orders_by_date
    col: 16
    ...

Button-Parameter

Mit dem in diesem Abschnitt beschriebenen Parameter können Sie einem LookML-Dashboard-Element vom Typ type: button Inhalte hinzufügen.

rich_content_json

rich_content_json ist ein JSON-Objekt mit mehreren Schlüssel/Wert-Paaren, die die Eigenschaften der Dashboard-Schaltfläche definieren.

Im folgenden Beispiel wird ein Dashboard-Schaltfläche gezeigt, mit der zu einem anderen Dashboard navigiert wird.

rich_content_json: '{
 "text": "Go to Sales Dashboard",
 "description": "View sales from the last 18 months.",
 "newTab": true,
 "alignment": "center",
 "size": "medium",
 "style": "FILLED",
 "color": "forestgreen",
 "href":"https://instance_name.looker.com/dashboards/152?State=California&Created+Fiscal+Quarter=2022"
 }'

Im folgenden Beispiel wird ein Dashboard-Schaltfläche gezeigt, mit der zu einem Tab im Dashboard navigiert wird.

rich_content_json: '{
 "text": "Go to Users tab",
 "description": "View user data from the last 18 months.",
 "newTab": false,
 "alignment": "center",
 "size": "medium",
 "style": "FILLED",
 "color": "forestgreen",
 "targetTabName":"Users"
 "href":""
 }'

text

text definiert den Text, der auf dem Button in der Dashboard-Benutzeroberfläche angezeigt wird. Die Schaltfläche wird in der Breite erweitert, um den Text aufzunehmen, bis sie das durch den Parameter width festgelegte Limit erreicht. Dann wird der Text abgeschnitten.

description

description definiert Text, der als Kurzinfo angezeigt wird, wenn Sie den Cursor über den Button bewegen. Wenn keine Beschreibung angegeben ist, wird standardmäßig der in href angegebene Link angezeigt.

newTab

newTab ist ein boolescher Wert, der angibt, ob der Button-Link in einem neuen Tab (true) oder im aktuellen Tab (false) geöffnet wird. Der Standardwert für newTab ist true.

alignment

Mit alignment wird die Ausrichtung des Buttons im Tile-Feld des Button-Elements festgelegt. Der Standardwert für alignment ist center.

Größe

Mit size wird die Größe der Schaltfläche und des zugehörigen Texts auf small, medium oder large festgelegt. Der Wert von size hat keinen Einfluss auf die Größe des Kachelkästchens des Schaltflächenelements oder auf den Parameter height.

style

Mit style wird der Stil der Schaltfläche auf einen der folgenden Werte festgelegt:

  • FILLED: Der Button-Body wird mit der Farbe gefüllt, die in color festgelegt ist. Der Text des Buttons ist weiß. Dies ist der Standardwert.
  • OUTLINED: Die Schaltfläche hat einen Umriss, aber der Rest ist transparent. Die Farbe des Schaltflächentexts wird durch color festgelegt.
  • TRANSPARENT: Der Button-Body ist transparent. Die Farbe des Button-Texts wird durch color festgelegt.

color

Mit color wird die Farbe des Buttons oder des Buttontexts festgelegt, je nach Einstellung von style. Für color wird standardmäßig die erste Farbe in der Standardfarbsammlung für Kategorien der Looker-Instanz verwendet.

Farbwerte können als Hexadezimalstrings wie #2ca6cd oder als CSS-Farbnamen wie mediumblue formatiert werden.

targetTabName

Wenn Ihr Dashboard Tabs hat, wird mit targetTabName der Dashboard-Tab festgelegt, zu dem Nutzer über die Schaltfläche gelangen.

Weitere Informationen zu Dashboards mit Tabs

href

Mit href wird die URL festgelegt, zu der Nutzer über die Schaltfläche gelangen. Links zu anderen Looker-Dashboards können Filterparameter enthalten, mit denen Dashboardfilter auf bestimmte Werte festgelegt werden.