Schaltflächenparameter für LookML-Dashboards

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

Auf dieser Seite wird beschrieben, 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 Ihren Dashboards platzieren. Sie können Links zu Looker-Inhalten wie Looks und Dashboards oder zu anderen Websites erstellen.

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 Typ der Visualisierung, die im Element verwendet werden soll
name (für Elemente) Erstellt ein Element
height (für Elemente) Definiert die Höhe des Kachelfelds eines Schaltflächenelements. Die Höhe wird bei layout: newspaper-Dashboards in Zeilen angegeben.
width (für Elemente) Definiert die Breite des Kachelfelds eines Schaltflächenelements. Die Breite wird bei layout: newspaper-Dashboards in Spalten angegeben.
row Definiert die vertikale Position des Kachelfelds eines Schaltflächenelements in Zeileneinheiten für layout: newspaper-Dashboards
col Definiert die Position des Kachelfelds eines Schaltflächenelements von links nach rechts in Spalteneinheiten für layout: newspaper-Dashboards
Button-Parameter
rich_content_json Ein JSON-Objekt, das Schlüssel/Wert-Paare mit Informationen zum Button enthält

Grundlegende Parameter

Wenn Sie ein LookML-Dashboard-Element 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 gelten für das Kachelfeld eines Schaltflächenelements, nicht für die Schaltfläche selbst.

name

In diesem Abschnitt geht es um den Parameter name, der Teil eines Dashboard-Elements ist.

name kann auch als Teil eines Dashboard-Filters verwendet werden, wie auf der Dokumentationsseite Dashboard-Parameter beschrieben.

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

Der dem Button zugewiesene name wird nicht in der Dashboard-Benutzeroberfläche angezeigt.

- name: orders_by_date

type

In diesem Abschnitt geht es um den Parameter type, der Teil eines Dashboard-Elements ist.

type kann auch als Teil eines Dashboard-Filters verwendet werden, wie auf der Dokumentationsseite Dashboard-Parameter beschrieben.

type kann auch als Teil eines Joins verwendet werden, wie auf der Dokumentationsseite für den Parameter type (für Joins) beschrieben.

type kann auch als Teil einer Dimension verwendet werden, wie auf der Dokumentationsseite Dimensionen, Filter und Parametertypen beschrieben.

type kann auch als Teil einer Measure verwendet werden, wie auf der Dokumentationsseite Measure-Typen beschrieben.

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 | group

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

height

In diesem Abschnitt geht es um den Parameter height, der Teil eines Dashboard-Elements ist.

height kann auch als Teil einer Dashboard-Zeile verwendet werden, wie auf der Dokumentationsseite Dashboard-Parameter beschrieben.

Der Parameter height definiert die Höhe des Kachelfelds eines Schaltflächenelements in Zeilen.

Die Tile-Felder von Button-Elementen haben standardmäßig 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 Kachelbox des Buttons auf 12 Zeilen festgelegt:

- dashboard: sales_overview
  layout: newspaper
  ...

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

width

In diesem Abschnitt geht es um den Parameter width, der Teil eines Dashboard-Elements ist.

width kann auch als Teil eines Dashboards verwendet werden, wie auf der Dokumentationsseite Dashboard-Parameter beschrieben.

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

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

Mit dem folgenden Code wird beispielsweise die Tile-Box einer Schaltfläche auf die Hälfte der Breite des Dashboards festgelegt:

- dashboard: sales_overview
  layout: newspaper
  ...

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

Wenn in der Kachel einer Schaltfläche Platz ist, wird die Breite der Schaltfläche 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. Falls erforderlich, wird der in text definierte String auf der Schaltfläche abgeschnitten.

row

Mit dem Parameter row wird die Zeile definiert, in der sich der obere Rand des Kachelfelds eines Schaltflächenelements befindet. Wenn die Schaltfläche mithilfe des Parameters group in einer Kachelgruppe platziert wird, definiert row die Zeilenposition der Schaltfläche relativ zum oberen Rand des Gruppencontainers (row: 0).

Ein Dashboard beginnt mit Zeile 0 oben im Dashboard. Dashboard-Schaltflächenelemente haben standardmäßig eine Höhe von 6 Zeilen. Das bedeutet, dass die Dashboard-Elemente oben im Dashboard (row: 0) standardmäßig die Zeilen 0 bis 5 einnehmen.

Im folgenden Beispiel wird im Code festgelegt, dass das Kachelfeld einer Schaltfläche in der zweiten Zeile der Elemente im Dashboard platziert wird, sofern die Elemente die Standardhöhe haben:

- 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 Kachelfelds des Schaltflächenelements befindet. Wenn die Schaltfläche mithilfe des Parameters group in einer Kachelgruppe platziert wird, definiert col die Spaltenposition der Schaltfläche relativ zum linken Rand des Gruppencontainers (col: 0).

Dashboards sind in 24 Spalten unterteilt. Ein Dashboard beginnt mit Spalte 0 auf der linken Seite des Dashboards. Ein Dashboard mit Zeitungs-Layout hat standardmäßig eine Elementbreite von 8 Spalten. Das bedeutet, dass die Dashboard-Elemente links im Dashboard (col: 0) standardmäßig die Spalten 0–7 einnehmen.

Mit dem folgenden Code wird beispielsweise ein Element in der dritten Spalte der Elemente im Dashboard festgelegt:

- 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-Button verwendet, über den ein anderes Dashboard aufgerufen 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-Button verwendet, über den ein Tab im Dashboard aufgerufen 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 der Schaltfläche in der Dashboard-Benutzeroberfläche angezeigt wird. Die Breite der Schaltfläche wird an den Text angepasst, bis das durch den Parameter width festgelegte Limit erreicht ist. Ab diesem Punkt wird der Text abgeschnitten.

description

Mit description wird Text definiert, der als Kurzinfo angezeigt wird, wenn Sie den Mauszeiger auf die Schaltfläche bewegen. Wenn keine Beschreibung angegeben ist, wird standardmäßig der in href angegebene Link angezeigt.

newTab

newTab ist ein boolescher Wert, der definiert, ob der Link der Schaltfläche 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 innerhalb des Kachelfelds des Button-Elements festgelegt. Der Standardwert für alignment ist center.

Größe

size legt die Größe der Schaltfläche und des Texts auf small, medium oder large fest. Der Wert von size hat keinen Einfluss auf die Größe des Kachelfelds des Schaltflächenelements oder auf den Parameter height.

style

style legt den Stil des Buttons auf einen der folgenden Werte fest:

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

color

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

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

href legt die URL fest, zu der Nutzer über die Schaltfläche weitergeleitet werden. Links zu anderen Looker-Dashboards können Filterparameter enthalten, mit denen Dashboard-Filter auf bestimmte Werte festgelegt werden.