Paramètres des boutons pour les tableaux de bord LookML

Les boutons ne sont compatibles qu'avec les tableaux de bord LookML qui présentent les paramètres suivants :

Cette page explique comment ajouter et personnaliser un élément de tableau de bord LookML type: button avec des paramètres de tableau de bord LookML dans un fichier dashboard.lkml. Les boutons sont utiles pour placer des liens dans vos tableaux de bord. Vous pouvez créer des liens vers du contenu Looker, comme des Looks et des tableaux de bord, ou vers d'autres sites Web.

Pour savoir comment ajouter des boutons à un tableau de bord dans l'interface utilisateur Looker, consultez la page de documentation Créer des tableaux de bord définis par l'utilisateur.

Exemple d'utilisation


## 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"
 }'

Définition des paramètres

Nom du paramètre Description
Paramètres de base
type (pour les éléments) Détermine le type de visualisation à utiliser dans l'élément.
name (pour les éléments) Crée un élément.
height (pour les éléments) Définit la hauteur de la zone de vignette d'un élément de bouton. La hauteur est exprimée en nombre de lignes pour les tableaux de bord layout: newspaper.
width (pour les éléments) Définit la largeur de la zone de vignette d'un élément de bouton. La largeur est exprimée en nombre de colonnes pour les tableaux de bord layout: newspaper.
row Définit la position de haut en bas de la boîte de vignette d'un élément de bouton en unités de lignes pour les tableaux de bord layout: newspaper.
col Définit la position de gauche à droite de la zone de vignette d'un élément de bouton en unités de colonnes pour les tableaux de bord layout: newspaper.
Paramètre du bouton
rich_content_json Objet JSON contenant des paires clé/valeur avec des informations sur le bouton

Paramètres de base

Lorsque vous définissez un élément de tableau de bord LookML de type type: button, vous devez spécifier des valeurs pour au moins les paramètres name et type.

Les paramètres height, width, row et col s'appliquent à la zone de tuile d'un élément de bouton, et non au bouton lui-même.

name

Cette section fait référence au paramètre name qui fait partie d'un élément de tableau de bord.

name peut également être utilisé dans un filtre de tableau de bord, comme décrit sur la page de documentation Paramètres du tableau de bord.

Chaque déclaration name crée un élément de tableau de bord et lui attribue un nom. Les noms des éléments doivent être uniques.

Le name attribué au bouton n'apparaît pas dans l'interface utilisateur du tableau de bord.

- name: orders_by_date

type

Cette section fait référence au paramètre type qui fait partie d'un élément de tableau de bord.

type peut également être utilisé dans un filtre de tableau de bord, comme décrit sur la page de documentation Paramètres du tableau de bord.

type peut également être utilisé dans une jointure, comme décrit sur la page de documentation du paramètre type (pour les jointures).

type peut également être utilisé dans une dimension, comme décrit sur la page de documentation Types de dimensions, de filtres et de paramètres.

type peut également être utilisé dans une mesure, comme décrit sur la page de documentation Types de mesures.

Le paramètre type détermine le type de visualisation à utiliser dans l'élément.

- 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

Pour obtenir une présentation des différents types d'éléments de tableau de bord LookML, consultez la page de documentation type (pour les tableaux de bord LookML).

height

Cette section fait référence au paramètre height qui fait partie d'un élément de tableau de bord.

height peut également être utilisé dans une ligne de tableau de bord, comme décrit sur la page de documentation Paramètres du tableau de bord.

Le paramètre height définit la hauteur de la boîte de tuiles d'un élément de bouton, en unités de ligne.

Par défaut, la hauteur des cases de vignettes des éléments de bouton est de six lignes. La hauteur minimale est d'une ligne. Modifier la hauteur de l'élément de bouton peut affecter d'autres éléments du tableau de bord, mais pas la hauteur du bouton lui-même.

Par exemple, le code suivant définit la hauteur de la boîte de tuiles du bouton sur 12 lignes :

- dashboard: sales_overview
  layout: newspaper
  ...

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

width

Cette section fait référence au paramètre width qui fait partie d'un élément de tableau de bord.

width peut également être utilisé dans un tableau de bord, comme décrit sur la page de documentation Paramètres du tableau de bord.

Le paramètre width définit la largeur de la boîte de tuiles d'un élément de bouton, en unités de colonnes.

Par défaut, la largeur de la case de la vignette d'un élément de bouton est de huit colonnes, soit un tiers de la largeur totale d'un tableau de bord. La largeur minimale de la boîte de tuiles d'un bouton est de 2.

Par exemple, le code suivant définit la taille de la boîte de tuiles d'un bouton sur la moitié de la largeur du tableau de bord :

- dashboard: sales_overview
  layout: newspaper
  ...

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

Si la boîte de la tuile d'un bouton contient de l'espace, la largeur du bouton augmente pour s'adapter à une longue chaîne de texte, définie dans text. Toutefois, la largeur du bouton ne dépassera pas la valeur définie dans le paramètre width. Si nécessaire, la chaîne définie dans text sera tronquée sur le bouton.

row

Le paramètre row définit la ligne sur laquelle le bord supérieur de la zone de mosaïque d'un élément de bouton est placé.

Un tableau de bord commence par la ligne 0 en haut du tableau de bord. Par défaut, les éléments de bouton du tableau de bord ont une hauteur de six lignes. Cela signifie que les éléments de tableau de bord en haut d'un tableau de bord (row: 0) occuperaient par défaut les lignes 0 à 5.

Dans l'exemple suivant, le code définit l'emplacement de la boîte de tuiles d'un bouton sur la deuxième ligne d'éléments du tableau de bord, en supposant que les éléments sont définis sur la hauteur par défaut :

- dashboard: sales_overview
  layout: newspaper
  ...

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

col

Le paramètre col définit la colonne sur laquelle est placée la bordure gauche de la boîte de tuiles de l'élément de bouton.

Les tableaux de bord sont divisés en 24 colonnes. Un tableau de bord commence par la colonne 0 à gauche. Un tableau de bord avec une mise en page de type journal a une largeur d'élément par défaut de huit colonnes. Cela signifie que les éléments de tableau de bord situés à gauche (col: 0) occuperaient par défaut les colonnes 0 à 7.

Par exemple, le code suivant définit un élément à définir dans la troisième colonne d'éléments du tableau de bord :

- dashboard: sales_overview
  layout: newspaper
  ...

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

Paramètre "Button" (Bouton)

Le paramètre décrit dans cette section peut être utilisé pour ajouter du contenu à un élément de tableau de bord LookML de type: button.

rich_content_json

rich_content_json est un objet JSON avec plusieurs paires clé/valeur qui définissent les caractéristiques du bouton du tableau de bord.

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 définit le texte qui s'affichera sur le bouton dans l'UI du tableau de bord. Le bouton s'élargit pour s'adapter au texte jusqu'à atteindre la limite définie par le paramètre width, après quoi le texte est tronqué.

description

description définit le texte qui s'affiche sous forme d'info-bulle lorsque l'utilisateur pointe sur le bouton. Si aucune description n'est fournie, le lien indiqué dans href s'affiche par défaut.

newTab

newTab est une valeur booléenne qui définit si le lien du bouton s'ouvre dans un nouvel onglet (true) ou dans l'onglet actuel (false). La valeur par défaut de newTab est true.

alignment

alignment définit l'alignement du bouton dans la zone de tuile de l'élément de bouton. alignment a la valeur par défaut center.

taille

size définit la taille du bouton et de son texte sur small, medium ou large. La valeur de size n'a pas d'incidence sur la taille de la zone de mosaïque de l'élément de bouton ni sur le paramètre height.

style

style définit le style du bouton sur l'une des valeurs suivantes :

  • FILLED : le corps du bouton est rempli par la couleur définie dans color. Le texte du bouton est blanc. Il s'agit de la valeur par défaut.
  • OUTLINED : le bouton a un contour, mais son corps est transparent. La couleur du texte du bouton est définie par color.
  • TRANSPARENT : le corps du bouton est transparent. La couleur du texte du bouton est définie par color.

color

color définit la couleur du bouton ou du texte du bouton, selon le paramètre style. color est défini par défaut sur la première couleur de la collection de couleurs catégorielles par défaut de l'instance Looker.

Les valeurs de couleur peuvent être mises en forme sous forme de chaînes hexadécimales, telles que #2ca6cd, ou sous forme de noms de couleurs CSS, tels que mediumblue.

href

href définit l'URL vers laquelle le bouton redirige les utilisateurs. Les liens vers d'autres tableaux de bord Looker peuvent contenir des paramètres de filtre qui définissent les filtres de tableau de bord sur des valeurs spécifiques.

Dans une expérience intégrée, les liens vers les tableaux de bord doivent contenir embed/ dans l'URL du lien.