Damit Sie Schaltflächenparameter verwenden können, muss Ihr Looker-Administrator die Labs-Funktion Benutzerdefinierte Schaltflächen für das Dashboard aktivieren.
Schaltflächen werden nur von LookML-Dashboards mit den folgenden Einstellungen unterstützt:
preferred_viewer
aufdashboards-next
festgelegtlayout
aufnewspaper
festgelegt
Auf dieser Seite wird beschrieben, wie Sie ein LookML-Dashboard-Element von type: button
mit LookML-Dashboard-Parametern in einer dashboard.lkml
-Datei hinzufügen und anpassen. Schaltflächen sind hilfreich, um Links in Dashboards einzufügen. 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-UI 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) |
Legt die Art der im Element zu verwendenden Visualisierung fest | |
name (für Elemente) |
Erstellt ein Element | |
height (für Elemente) |
Definiert die Höhe des Kachelfelds eines Schaltflächenelements. Höhe wird für layout: newspaper -Dashboards in Zeileneinheiten angegeben. |
|
width (für Elemente) |
Definiert die Breite des Kachelfelds eines Schaltflächenelements. Breite wird für layout: newspaper -Dashboards in Spalten angegeben. |
|
row |
Definiert die Position des Kachelfelds eines Schaltflächenelements in Zeilen für layout: newspaper -Dashboards von oben nach unten |
|
col |
Definiert die Position des Kachelfelds eines Schaltflächenelements, das von links nach rechts verläuft, in Spaltenspalten 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-Dashboard-Element von type: button
definieren, müssen Sie Werte für mindestens 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
Dieser Abschnitt bezieht sich auf den Parameter
name
, der Teil eines Dashboard-Elements ist.
name
kann auch als Teil eines Dashboard-Filters verwendet werden, der auf der Dokumentationsseite zu Dashboard-Parametern beschrieben wird.
Mit jeder name
-Deklaration wird ein neues Dashboard-Element erstellt und ihm ein Name zugewiesen. Elementnamen müssen eindeutig sein.
Der name
für die Schaltfläche wird nicht in der Dashboard-Benutzeroberfläche angezeigt.
- name: orders_by_date
type
Dieser Abschnitt bezieht sich auf den Parameter
type
, der Teil eines Dashboard-Elements ist.
type
kann auch als Teil eines Dashboard-Filters verwendet werden, der auf der Dokumentationsseite zu Dashboard-Parametern beschrieben wird.
type
kann auch als Teil eines Joins verwendet werden (siehe Dokumentation zum Parametertype
(für Joins)).
type
kann auch als Teil einer Dimension verwendet werden. Weitere Informationen dazu finden Sie auf der Dokumentationsseite zu Dimensionen, Filtern und Parametertypen.
type
kann auch als Teil einer Messung verwendet werden, wie auf der Dokumentationsseite zu Messtypen beschrieben.
Der Parameter type
bestimmt die Art der Visualisierung, die 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
Auf der Dokumentationsseite zu type
(für LookML-Dashboards) finden Sie eine Übersicht über die verschiedenen Arten von LookML-Dashboard-Elementen.
height
Dieser Abschnitt bezieht sich auf den Parameter
height
, der Teil eines Dashboard-Elements ist.
height
kann auch als Teil einer Dashboard-Zeile verwendet werden, wie auf der Dokumentationsseite zu Dashboard-Parametern beschrieben.
Der Parameter height
definiert die Höhe des Kachelfelds eines Schaltflächenelements in der Einheit Zeile.
Die Kachelelemente der Schaltflächenelemente sind standardmäßig auf sechs Zeilen festgelegt. Die Mindesthöhe beträgt 1 Zeile. Das Ändern der Höhe des Schaltflächenelements kann sich auf andere Elemente im Dashboard, nicht aber auf die Höhe der Schaltfläche selbst auswirken.
Der folgende Code legt beispielsweise den Kachelrahmen der Schaltfläche auf 12 Zeilen hoch fest:
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
height: 12
...
width
Dieser Abschnitt bezieht sich auf den Parameter
width
, der Teil eines Dashboard-Elements ist.
width
kann auch als Teil eines Dashboards verwendet werden, wie auf der Dokumentationsseite zu den Dashboard-Parametern beschrieben.
Der Parameter width
definiert die Breite des Kachelfelds eines Schaltflächenelements in Spaltenspalten.
Die Breite des Kachelfelds eines Schaltflächenelements beträgt standardmäßig 8 Spalten, also ein Drittel der vollen Breite eines Dashboards. Die Mindestbreite des Kachelfelds einer Schaltfläche beträgt 2
.
Mit dem folgenden Code wird beispielsweise der Kachelrahmen 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 im Kachelfeld einer Schaltfläche Platz ist, wird die Breite der Schaltfläche so vergrößert, dass sie einen langen Textstring enthält, der in text
definiert ist. Die Breite einer 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 abgeschnitten.
row
Der Parameter row
definiert die Zeile, auf der der obere Rand des Kachelfelds eines Schaltflächenelements platziert wird.
Ein Dashboard beginnt mit Zeile 0 oben im Dashboard. Dashboard-Schaltflächenelemente haben standardmäßig eine Elementhöhe von 6 Zeilen. Das bedeutet, dass die Dashboard-Elemente oben auf einem Dashboard (row: 0
) standardmäßig die Zeilen 0–5 einnehmen.
Im folgenden Beispiel wird durch den Code festgelegt, dass das Kachelfeld einer Schaltfläche in der zweiten Zeile der Elemente im Dashboard platziert wird. Dabei wird davon ausgegangen, dass die Elemente auf der Standardhöhe festgelegt sind:
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
row: 6
...
col
Der Parameter col
definiert die Spalte, auf der der linke Rand des Kachelfelds des Schaltflächenelements platziert wird.
Dashboards sind in 24 Spalten unterteilt. Ein Dashboard beginnt mit Spalte 0 links vom Dashboard. Ein Dashboard mit Zeitungslayout hat standardmäßig eine Elementbreite von 8 Spalten. Das bedeutet, dass die Dashboard-Elemente links vom Dashboard (col: 0
) standardmäßig die Spalten 0–7 belegen.
Der folgende Code legt beispielsweise ein Element fest, das in der dritten Spalte von Elementen im Dashboard festgelegt wird:
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
col: 16
...
Schaltflächenparameter
Mit dem in diesem Abschnitt beschriebenen Parameter können Sie dem LookML-Dashboard-Element von type: button
Inhalte hinzufügen.
rich_content_json
rich_content_json
ist ein JSON-Objekt mit mehreren Schlüssel/Wert-Paaren, die Eigenschaften der Dashboard-Schaltfläche definieren.
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"
}'
text
text
definiert den Text, der auf der Schaltfläche in der Dashboard-Benutzeroberfläche angezeigt wird. Die Schaltfläche wird in die Breite erweitert, bis der Text erreicht ist, bis das durch den Parameter width
festgelegte Limit erreicht ist. Danach wird der Text abgeschnitten.
description
description
definiert Text, der als Pop-up-Kurzinfo eingeblendet wird, wenn der Mauszeiger auf die Schaltfläche bewegt wird. Wenn keine Beschreibung angegeben ist, wird standardmäßig der in href
angegebene Link angezeigt.
newTab
newTab
ist ein boolescher Wert, mit dem festgelegt wird, ob der Link zur Schaltfläche in einem neuen Tab (true
) oder im aktuellen Tab (false
) geöffnet wird. Für newTab
ist standardmäßig true
festgelegt.
alignment
Mit alignment
wird die Ausrichtung der Schaltfläche im Kachelfeld des Schaltflächenelements festgelegt. Die Standardeinstellung für alignment
ist center
.
Größe
size
legt die Größe der Schaltfläche und ihren Text auf small
, medium
oder large
fest. Der Wert von size
hat keinen Einfluss auf die Größe des Kachelfelds des Schaltflächenelements oder des Parameters height
.
style
Mit style
wird der Stil der Schaltfläche auf einen der folgenden Werte festgelegt:
FILLED
: Der Text der Schaltfläche wird durch die incolor
festgelegte Farbe ausgefüllt. Der Text der Schaltfläche ist weiß. Dies ist der Standardwert.OUTLINED
: Die Schaltfläche hat einen Rahmen, der Text ist aber transparent. Die Farbe des Schaltflächentexts wird voncolor
festgelegt.TRANSPARENT
: Der Text der Schaltfläche ist transparent. Die Farbe des Schaltflächentexts wird voncolor
festgelegt.
color
color
legt die Farbe der Schaltfläche oder des Schaltflächentexts abhängig von der Einstellung für style
fest. color
ist die Standardfarbe in der kategorialen Standardsammlung der Looker-Instanz.
Farbwerte können als Hexadezimalstrings wie #2ca6cd
oder als CSS-Farbnamen wie mediumblue
formatiert werden.
href
Mit href
wird die URL festgelegt, zu der Nutzer über die Schaltfläche weitergeleitet werden. Links zu anderen Looker-Dashboards können Filterparameter enthalten, die Dashboard-Filter auf bestimmte Werte festlegen.
Bei eingebetteten Inhalten müssen Links zu Dashboards
embed/
in der Link-URL enthalten.