Cette page explique comment ajouter et personnaliser un élément de tableau de bord LookML de type type: text avec des paramètres de tableau de bord LookML dans un fichier dashboard.lkml.
Pour savoir comment ajouter du texte à un tableau de bord via l'interface utilisateur de Looker, consultez la page de documentation Créer des tableaux de bord définis par l'utilisateur.
Exemple d'utilisation
## BASIC PARAMETERS
name: element_name
type: text
height: N
width: N
top: N
left: N
row: N
col: N
## TEXT PARAMETERS
title_text: title text
subtitle_text: subtitle text
body_text: body text
Définition des paramètres
| Nom du paramètre | Description | |
|---|---|---|
| Paramètres de base | ||
name (pour les éléments) |
Crée un élément. | |
type (pour les éléments) |
Détermine le type de visualisation à utiliser dans l'élément. | |
height (pour les éléments) |
Définit la hauteur d'un élément en unités de tile_size pour les tableaux de bord layout: tile et layout: static |
|
width (pour les éléments) |
Définit la largeur d'un élément en unités de tile_size pour les tableaux de bord layout: tile et layout: static |
|
top |
Définit la position de haut en bas d'un élément en unités de tile_size pour les tableaux de bord layout: static |
|
left |
Définit la position de gauche à droite d'un élément en unités de tile_size pour les tableaux de bord layout: static |
|
row |
Définit la position verticale d'un élément en nombre de lignes pour les tableaux de bord layout: newspaper |
|
col |
Définit la position de gauche à droite d'un élément en unités de colonnes pour les tableaux de bord layout: newspaper |
|
| Paramètres textuels | ||
title_text |
Spécifie un titre pour un élément du tableau de bord de type: text |
|
subtitle_text |
Spécifie un sous-titre pour un élément du tableau de bord de type: text |
|
body_text |
Spécifie le corps du texte d'un élément de tableau de bord de type: text |
|
Paramètres de base
Lorsque vous définissez un élément de tableau de bord LookML de type type: text, vous devez spécifier des valeurs pour au moins les paramètres name et type.
name
Cette section fait référence au paramètre
namequi fait partie d'un élément de tableau de bord.
namepeut également être utilisé dans un filtre de tableau de bord, comme décrit sur la page de documentation Paramètres de tableau de bord.
Chaque déclaration name crée un élément du tableau de bord et lui attribue un nom.
Les noms des éléments doivent être uniques. Les noms sont parfois référencés dans le paramètre elements lorsque vous utilisez des tableaux de bord layout: grid, ou dans le paramètre group des éléments enfants lorsque vous organisez des éléments dans un groupe de tuiles (type: group).
- name: orders_by_date
type
Cette section fait référence au paramètre
typequi fait partie d'un élément de tableau de bord.
typepeut également être utilisé dans un filtre de tableau de bord, comme décrit sur la page de documentation Paramètres de tableau de bord.
typepeut également être utilisé dans le cadre d'une jointure, comme décrit sur la page de documentation du paramètretype(pour les jointures).
typepeut également être utilisé dans une dimension, comme décrit sur la page de documentation Types de dimensions, de filtres et de paramètres.
typepeut é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_google_map | looker_geo_coordinates | looker_geo_choropleth |
looker_waterfall | looker_wordcloud | looker_boxplot | button | group
Consultez la page de documentation type (pour les tableaux de bord LookML) pour obtenir une présentation des différents types d'éléments de tableau de bord LookML.
height
Cette section fait référence au paramètre
heightqui fait partie d'un élément de tableau de bord.
heightpeut également être utilisé dans une ligne de tableau de bord, comme décrit sur la page de documentation Paramètres de tableau de bord.
Pour les tableaux de bord avec des mises en page tile ou static
Le paramètre height définit la hauteur d'un élément, en unités de tile_size (qui est défini en pixels), pour les tableaux de bord layout: tile et layout: static.
Par exemple, le code suivant spécifie tile_size: 100 et height: 4, ce qui donne à l'élément orders_by_date une hauteur de 400 pixels.
- dashboard: sales_overview
tile_size: 100
...
elements:
- name: orders_by_date
height: 4
...
Pour les tableaux de bord avec une mise en page newspaper
Le paramètre height définit la hauteur d'un élément, en unités de row, pour les tableaux de bord layout: newspaper.
Un tableau de bord avec une mise en page de type journal utilise par défaut une hauteur d'élément de six lignes, soit environ 300 pixels. La hauteur minimale est d'une ligne pour les tableaux de bord dont le paramètre preferred viewer est défini sur dashboards-next. La hauteur minimale est de deux lignes pour les tableaux de bord dont le paramètre preferred viewer est défini sur dashboards.
Par exemple, le code suivant définit un élément sur une hauteur de 12 lignes, soit deux fois plus haut que les autres éléments définis sur la valeur par défaut :
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
height: 12
...
width
Cette section fait référence au paramètre
widthqui fait partie d'un élément de tableau de bord.
widthpeut également être utilisé dans un tableau de bord, comme décrit sur la page de documentation Paramètres de tableau de bord.
Le paramètre width définit la largeur d'un élément, en unités de tile_size, pour les tableaux de bord layout: tile et layout: static.
Par exemple, le code suivant spécifie tile_size: 100 et width: 4, ce qui donne à l'élément orders_by_date une largeur de 400 pixels.
- dashboard: sales_overview
tile_size: 100
...
elements:
- name: orders_by_date
width: 4
...
Le paramètre width définit la largeur d'un élément, en unités de colonnes, pour les tableaux de bord layout: newspaper.
Par défaut, un tableau de bord avec une mise en page de type journal comporte 24 colonnes.
Par exemple, le code suivant définit l'élément sur la moitié de la largeur du tableau de bord :
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
width: 12
...
top
Le paramètre top définit la position de haut en bas d'un élément, en unités de tile_size, pour les tableaux de bord layout: static.
Par exemple, le code suivant spécifie tile_size: 100 et top: 4, ce qui positionne le bord supérieur de l'élément orders_by_date à 400 pixels du haut du tableau de bord.
- dashboard: sales_overview
tile_size: 100
...
elements:
- name: orders_by_date
top: 4
...
left
Le paramètre left définit la position de gauche à droite d'un élément, en unités de tile_size, pour les tableaux de bord layout: static.
Par exemple, le code suivant spécifie tile_size: 100 et left: 4, en positionnant le bord gauche de l'élément orders_by_date à 400 pixels du côté gauche du tableau de bord.
- dashboard: sales_overview
tile_size: 100
...
elements:
- name: orders_by_date
left: 4
...
row
Pour les tableaux de bord layout: newspaper, le paramètre row définit la ligne sur laquelle le bord supérieur d'un élément est placé. Si l'élément est placé dans un groupe de tuiles à l'aide du paramètre group, row définit la position de la ligne de l'élément par rapport au haut du conteneur du groupe (row: 0).
Un tableau de bord commence par la ligne 0 en haut du tableau de bord. Un tableau de bord avec une mise en page de type journal a une hauteur d'élément par défaut de six lignes, ce qui signifie que les éléments du tableau de bord situés en haut (row: 0) occupent par défaut les lignes 0 à 5.
Chaque ligne mesure 50 pixels de haut, ce qui signifie que la hauteur par défaut de l'élément (six lignes) est de 300 pixels.
Par exemple, le code suivant définit un élément à placer sur la deuxième ligne d'éléments du tableau de bord, en supposant que les éléments sont définis à la hauteur par défaut :
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
row: 6
...
col
Pour les tableaux de bord layout: newspaper, le paramètre col définit la colonne sur laquelle le bord gauche de l'élément est placé. Si l'élément est placé dans un groupe de tuiles à l'aide du paramètre group, col définit la position de la colonne de l'élément par rapport au bord gauche du conteneur du groupe (col: 0).
Les tableaux de bord sont divisés en 24 colonnes. Un tableau de bord commence par la colonne 0 à gauche du tableau de bord. Un tableau de bord avec une mise en page de type journal utilise par défaut une largeur d'élément de huit colonnes, ce qui signifie que les éléments du tableau de bord situés à gauche (col: 0) occupent par défaut les colonnes 0 à 7.
Par exemple, le code suivant définit un élément à placer 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ètres textuels
Le code LookML du tableau de bord généré à partir de tuiles de texte créées avec l'option Texte de l'interface utilisateur de Looker n'utilisera pas les paramètres
title_textousubtitle_text.
Les paramètres décrits dans cette section peuvent être utilisés pour ajouter du contenu à un élément de tableau de bord LookML de type: text.
title_text
Le paramètre title_text spécifie le texte qui s'affichera sur un élément type: text dans la plus grande taille de police disponible. Il s'affiche en haut de la vignette.
title_text: title text
subtitle_text
Le paramètre subtitle_text spécifie le texte qui s'affichera sur un élément type: text dans la taille de police moyenne disponible. Si title_text est présent, subtitle_text s'affiche en dessous.
subtitle_text: subtitle text
body_text
Le paramètre body_text spécifie le texte qui s'affichera sur un élément type: text dans la plus petite taille de police disponible. Ce paramètre est affiché en dernier dans la vignette de texte. La page de documentation Utiliser Markdown dans les tuiles Markdown présente le langage Markdown que vous pouvez utiliser pour mettre en forme du texte ou ajouter des liens et des images à une tuile de texte.
body_text: body text