Paramètres du tableau de bord LookML

Vous pouvez créer des tableaux de bord de deux manières. Les tableaux de bord définis par l'utilisateur sont créés à l'aide de l'interface utilisateur Looker. Pour en savoir plus, consultez la page de documentation Créer des tableaux de bord définis par l'utilisateur. Vous pouvez également créer des tableaux de bord avec LookML et modifier leurs paramètres généraux comme indiqué sur cette page.

Cette page décrit les paramètres de tableau de bord LookML qui affectent l'ensemble du tableau de bord.

Un tableau de bord LookML contient également des éléments, qui sont les visualisations de données, les zones de texte et les boutons du tableau de bord. Consultez la page Paramètres des éléments du tableau de bord pour accéder aux pages de référence de chaque type d'élément.

Exemple d'utilisation

- dashboard: dashboard_name
  preferred_viewer: dashboards | dashboards-next
  title: "chosen dashboard title"
  description: "chosen dashboard description"
  enable_viz_full_screen: true | false
  extends: name_of_dashboard_being_extended
  extension: required
  layout: tile | static | grid | newspaper
  rows:
    - elements: [element_name, element_name, ...]
      height: N
  tile_size: N
  width: N
  refresh: N (seconds | minutes | hours | days)
  auto_run: true | false

  # DASHBOARD FILTER PARAMETERS
  crossfilter_enabled: true | false
  filters_bar_collapsed: true | false
  filters_location_top: true | false
  filters:
  - name: filter_name
    title: "chosen filter title"
    type: field_filter | number_filter | date_filter | string_filter
    model: model_name
    explore: explore_name
    field: view_name.field_name
    default_value: Looker filter expression
    allow_multiple_values: true | false
    required: true | false
    ui_config:
      type: button_group | checkboxes | range_slider | tag_list | radio_buttons |
            button_toggles | dropdown_menu | slider | day_picker | day_range_picker |
            relative_timeframes | advanced
      display: inline | popover | overflow
      options:
        min: N
        max: N
      - value options
    listens_to_filters:
    - filter_name
      field: view_name.field_name

  # EMBEDDED DASHBOARD PARAMETERS
  embed_style:
    background_color: "css_color"
    show_title: true | false
    title_color: "css_color"
    show_filters_bar: true | false
    tile_background_color: "css_color"
    tile_text_color: "css_color"

  # ELEMENTS PARAMETERS
  elements:
  # One or more element declarations

Définition des paramètres

Nom du paramètre Description
dashboard Créez un tableau de bord.
preferred_viewer Ce paramètre est ignoré.
title (pour le tableau de bord) Modifiez la façon dont le nom d'un tableau de bord s'affiche pour les utilisateurs.
description (pour le tableau de bord) Ajoutez une description qui sera visible dans le panneau Détails du tableau de bord ou dans les dossiers en vue Liste.
enable_viz_full_screen Définissez si les lecteurs de tableaux de bord peuvent voir les vignettes de tableaux de bord en plein écran et en vue développée.
extends Basez le tableau de bord LookML sur un autre tableau de bord LookML.
extension Exige que le tableau de bord actuel soit basé sur un autre tableau de bord.
layout Définissez la façon dont le tableau de bord placera les éléments.
rows Marque le début d'une section de code LookML pour définir les éléments qui doivent figurer dans chaque ligne d'un tableau de bord layout: grid.
elements (pour les lignes) Définissez les éléments qui doivent figurer dans une ligne d'un tableau de bord layout: grid.
height (pour les lignes) Définissez la hauteur d'une ligne pour un tableau de bord layout: grid.
tile_size Définissez la taille d'une vignette pour un tableau de bord layout: tile.
width (pour le tableau de bord) Définissez la largeur du tableau de bord pour un tableau de bord layout: static.
refresh (pour le tableau de bord) Définissez l'intervalle d'actualisation automatique des éléments du tableau de bord.
auto_run Déterminez si les tableaux de bord doivent s'exécuter automatiquement lorsqu'ils sont ouverts ou actualisés.
Paramètres de filtre
crossfilter_enabled Activez ou désactivez le filtrage croisé pour un tableau de bord.
filters_bar_collapsed Ajouté dans la version 21.16 Définissez la barre de filtres du tableau de bord comme réduite ou développée par défaut pour un tableau de bord.
filters_location_top Ajouté dans la version 22.8 Définissez l'emplacement de la barre de filtres du tableau de bord sur en haut ou à droite pour un tableau de bord.
filters (pour le tableau de bord) Marque le début d'une section de code LookML pour définir les filtres du tableau de bord.
name (pour les filtres) Créer un filtre.
title (pour les filtres) Modifiez la façon dont le nom d'un filtre s'affiche pour les utilisateurs.
type (pour les filtres) Déterminez le type de filtre à utiliser.
default_value Définissez une valeur par défaut pour un filtre.
allow_multiple_values Limitez les utilisateurs à une seule valeur de filtre.
required Obligez les utilisateurs à saisir une valeur de filtre pour exécuter le tableau de bord.
ui_config Configurez les commandes de filtre disponibles lorsque les utilisateurs consultent un tableau de bord LookML. Comporte les sous-paramètres type, display et options.
model (pour les filtres) Spécifiez le modèle qui contient le champ sous-jacent d'un filtre type: field_filter.
explore (pour les filtres) Indiquez l'exploration qui contient le champ sous-jacent d'un filtre type: field_filter.
field Spécifiez le champ sous-jacent d'un filtre type: field_filter.
listens_to_filters Affiner les suggestions de filtres de tableau de bord field_filter en fonction de ce que l'utilisateur saisit pour un autre filtre de tableau de bord type: field_filter.
Paramètres des tableaux de bord intégrés
embed_style Marque le début d'une section de code LookML pour définir les personnalisations de tableaux de bord intégrés.
background_color Définissez la couleur d'arrière-plan d'un tableau de bord intégré.
show_title Indiquez si le titre du tableau de bord est visible sur un tableau de bord intégré.
title_color Définissez la couleur du titre d'un tableau de bord intégré.
show_filters_bar Indiquez si la barre de filtres est visible sur un tableau de bord intégré.
tile_background_color Définissez la couleur d'arrière-plan des tuiles d'un tableau de bord intégré.
tile_text_color Définissez la couleur du texte des cartes d'un tableau de bord intégré.
Paramètres des éléments
elements (pour le tableau de bord) Marque le début d'une section de code LookML pour définir les éléments du tableau de bord.

dashboard

Le paramètre dashboard déclare un nouveau tableau de bord et spécifie son nom. Le nombre maximal de caractères est de 255. Les caractères autorisés sont les lettres (A-Z), les chiffres (0-9), les tirets (-) et les traits de soulignement (_). Il est généralement recommandé de placer chaque tableau de bord LookML dans son propre fichier LookML, mais il est possible de déclarer plusieurs tableaux de bord dans un même fichier.

- dashboard: sales_overview

Pour afficher quoi que ce soit, un tableau de bord doit contenir au moins un élément ajouté à l'aide du paramètre elements.

preferred_viewer

Avant l'abandon des anciens tableaux de bord dans Looker 23.6, le paramètre preferred_viewer vous permettait de choisir le format d'affichage et de téléchargement d'un tableau de bord : l'expérience liée aux tableaux de bord par défaut de Looker ou un ancien tableau de bord.

title (pour le tableau de bord)

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

title peut également être utilisé dans un filtre de tableau de bord, comme décrit dans la section title (pour les filtres) de cette page.

title peut également être utilisé dans n'importe quel élément de tableau de bord. Un exemple représentatif de son utilisation est fourni sur la page de documentation Éléments du graphique à colonnes.

Le paramètre title vous permet de modifier la façon dont le nom d'un tableau de bord s'affiche pour les utilisateurs dans les dossiers et en haut du tableau de bord. Si aucun titre n'est spécifié, le nom du tableau de bord est utilisé par défaut. Le texte du titre peut être localisé.

Considérez l'exemple suivant :

- dashboard: sales_overview
  title: "1) Sales Overview"

Si vous l'avez fait, au lieu d'afficher le tableau de bord Aperçu des ventes, il s'afficherait sous la forme 1) Aperçu des ventes.

description (pour le tableau de bord)

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

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

description peut également être utilisé dans un champ, comme décrit sur la page de documentation du paramètre description (pour les champs).

Le paramètre description vous permet d'ajouter une description à un tableau de bord LookML.

Le contenu du paramètre description s'affiche dans le champ Description du panneau Détails du tableau de bord d'un tableau de bord LookML.

La description s'affiche sous le titre du tableau de bord dans les listes de tableaux de bord lorsqu'elles sont affichées dans un dossier défini sur la vue Liste. Si aucune description n'est spécifiée, la liste n'affiche que le titre du tableau de bord.

Le texte de la description peut être localisé.

enable_viz_full_screen

Ce paramètre ne prend effet que lorsque le paramètre "Visualisations en plein écran" est activé par un administrateur Looker. Le paramètre Visualisation plein écran est activé par défaut.

Le paramètre enable_viz_full_screen vous permet de définir si les lecteurs de tableaux de bord peuvent voir les vignettes de tableaux de bord en plein écran et en vue développée. Il équivaut au paramètre de tableau de bord Autoriser le mode plein écran pour les visualisations.

Ce paramètre accepte les valeurs true (vues plein écran et agrandies disponibles) et false (vues plein écran et agrandies non disponibles). La valeur par défaut est true.

extends

Comme décrit sur la page de documentation Réutiliser des codes avec "extends", le paramètre extends vous permet de baser un tableau de bord LookML sur un autre tableau de bord LookML, en ajoutant ou en remplaçant éventuellement certains paramètres. Le paramètre extends accepte le nom d'un autre tableau de bord LookML.

Lorsque vous étendez un objet, sachez que les règles de localisation s'appliquent également à vos extensions. Si vous étendez un objet, puis définissez de nouveaux libellés ou descriptions, vous devez fournir des définitions de localisation dans les fichiers de chaînes de paramètres régionaux de votre projet. Pour en savoir plus, consultez la page de documentation Localisation de votre modèle LookML.

extension

Comme décrit sur la page de documentation Réutiliser du code avec "extends", le paramètre extension indique que le tableau de bord doit être étendu par un autre tableau de bord. Ce tableau de bord n'est jamais visible par les autres utilisateurs, mais il peut servir de modèle pour créer d'autres tableaux de bord visibles par les autres utilisateurs. Le paramètre extension n'accepte que la valeur required. Si le paramètre extension n'est pas inclus, l'extension n'est pas requise pour le tableau de bord.

layout

Le paramètre layout définit la méthode de mise en page que Looker utilisera pour positionner les éléments du tableau de bord. Elle accepte les valeurs suivantes :

rows

Pour les tableaux de bord layout: grid, le paramètre rows lance la section de code LookML dans laquelle vous définissez les éléments à insérer dans chaque ligne, ainsi que la hauteur de chaque ligne. Dans chaque ligne, chaque élément a la même largeur. Si vous n'incluez pas un élément dans cette section, il n'apparaîtra pas dans le tableau de bord.

- dashboard: sales_overview
  layout: grid
  rows:
    - elements: [element_name, element_name, ...]
      height: 200
    - elements: [element_name, element_name, ...]
      height: 300

elements

Le paramètre elements accepte une liste de noms d'éléments de tableau de bord, séparés par des virgules. Chaque déclaration elements crée une ligne dans le tableau de bord. Tous les éléments placés sur une même ligne auront la même largeur. Par exemple, si vous placez deux éléments sur une même ligne, chacun d'eux occupera 50 % de l'espace disponible. Si vous placez quatre éléments sur une ligne, chacun occupera 25 % de l'espace disponible.

height

Le paramètre height définit la hauteur d'une ligne en pixels. La valeur par défaut est 300.

tile_size

Pour les tableaux de bord layout: tile et layout: static, l'unité utilisée pour dimensionner et positionner les éléments est la taille de la tuile. Vous définissez tile_size en pixels. La valeur par défaut est 160. Exemple :

- dashboard: sales_overview
  layout: tile
  tile_size: 100

Dans ce cas, un élément de tableau de bord avec height: 5 et width: 3 mesurera 500 pixels de haut et 300 pixels de large. Les paramètres height et width s'appliquent à tous les types d'éléments. Pour en savoir plus sur leur utilisation, consultez les pages de documentation pour chaque type de visualisation. Pour obtenir un exemple représentatif du fonctionnement de height et width, consultez la page de documentation Paramètres des graphiques à barres pour les tableaux de bord LookML.

width

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

width peut également être utilisé dans un élément de tableau de bord. Un exemple représentatif de son utilisation est fourni sur la page de documentation des éléments du graphique à colonnes.

Pour les tableaux de bord layout: static, le paramètre width définit la largeur totale du tableau de bord que vous prévoyez d'utiliser en pixels. Le paramètre width ne limitera pas la taille du tableau de bord si vous définissez un élément trop grand ou trop d'éléments à la suite. Le paramètre width permet de maintenir le tableau de bord au centre de l'écran. Si vous ne définissez pas de largeur, la valeur par défaut est 1 200.

- dashboard: sales_overview
  layout: static
  width: 800

refresh

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

refresh peut également être utilisé dans un élément de tableau de bord. Un exemple représentatif de son utilisation est fourni sur la page de documentation des éléments de graphique à colonnes.

Le paramètre refresh permet à un tableau de bord de se recharger automatiquement à intervalles réguliers, ce qui permet de récupérer de nouvelles données. Cela est souvent utile dans les paramètres où un tableau de bord est constamment affiché, par exemple sur un téléviseur de bureau. Notez que le tableau de bord doit être ouvert dans une fenêtre de navigateur pour que ce paramètre ait un effet. Ce paramètre ne s'exécute pas en arrière-plan pour "pré-remplir" le cache du tableau de bord.

La fréquence d'actualisation peut être n'importe quel nombre (sans décimales) de secondes, minutes, heures ou jours. Exemple :

- dashboard: sales_overview
  refresh: 2 hours

Soyez prudent lorsque vous définissez des intervalles d'actualisation courts. Étant donné que les tableaux de bord peuvent contenir de nombreuses requêtes, dont certaines peuvent être gourmandes en ressources, certains tableaux de bord peuvent mettre à rude épreuve votre base de données.

auto_run

Le paramètre auto_run détermine si un tableau de bord s'exécute lorsqu'il est ouvert ou actualisé pour la première fois. La valeur par défaut est true. Lorsque ce paramètre est défini sur false, les utilisateurs doivent appuyer sur un bouton Exécuter pour charger le tableau de bord. Par exemple, un tableau de bord comme celui-ci s'exécutera automatiquement à l'ouverture :

- dashboard: sales_overview
  auto_run: true

Quel que soit le paramètre auto_run, les utilisateurs doivent toujours cliquer sur le bouton Exécuter après avoir modifié les valeurs des filtres. Cela permet d'éviter les rechargements indésirables lorsqu'un utilisateur met en pause le changement de filtre ou souhaite modifier plusieurs filtres en même temps.

crossfilter_enabled

Le paramètre crossfilter_enabled vous permet d'activer ou de désactiver les filtres croisés pour un tableau de bord. Lorsque ce paramètre est défini sur true, les lecteurs de tableaux de bord peuvent créer des filtres croisés dans le tableau de bord en cliquant sur certains points de données.

- dashboard: sales_data
  crossfilter_enabled: true

filters_bar_collapsed

Le paramètre filters_bar_collapsed vous permet de définir la barre de filtre du tableau de bord comme réduite ou développée par défaut pour un tableau de bord. Lorsque ce paramètre est défini sur true, la barre de filtres est réduite par défaut. Les lecteurs de tableaux de bord peuvent développer la barre de filtres en cliquant sur l'icône de filtres. Le paramètre par défaut est false.

- dashboard: sales_data
  filters_bar_collapsed: true

filters_location_top

Le paramètre filters_location_top vous permet de placer la barre de filtres du tableau de bord en haut ou à droite. Lorsque ce paramètre est défini sur true, la barre de filtre s'affiche en haut du tableau de bord. Lorsqu'il est défini sur false, elle s'affiche à droite. Le paramètre par défaut est true.

- dashboard: sales_data
  filters_location_top: false

filters

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

filters peut également être utilisé dans un élément de tableau de bord. Un exemple représentatif de son utilisation est fourni sur la page de documentation des éléments de graphique à colonnes.

filters peut également être utilisé dans une mesure, comme décrit sur la page de documentation du paramètre filters.

Le paramètre filters marque le début de la section LookML dans laquelle vous définissez les filtres de tableau de bord. Les filtres s'affichent en haut du tableau de bord et permettent aux utilisateurs de modifier les données sous-jacentes des éléments du tableau de bord.

Pour qu'un filtre ait un impact sur un élément, celui-ci doit être configuré pour "écouter" ce filtre à l'aide du paramètre listen. Ce paramètre s'applique à tous les types d'éléments, à l'exception de type: text et type: button. Pour obtenir un exemple représentatif du fonctionnement de listen, consultez la page de documentation Paramètres des graphiques à barres pour les tableaux de bord LookML.

Lorsque des filtres sont appliqués à un élément de cette manière, il est important que le type de filtre corresponde au type de dimension ou de mesure qui écoute le filtre (pour en savoir plus, consultez Créer des tableaux de bord LookML). Les filtres se présentent comme suit :

filters:
- name: filter_name
  title: "chosen filter title"
  type: field_filter | number_filter | date_filter | string_filter
  model: model_name
  explore: explore_name
  field: view_name.field_name
  default_value: Looker filter expression
  allow_multiple_values: true | false
  required: true | false
  listens_to_filters:
  - filter_name
    field: view_name.field_name

name

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

name peut également être utilisé dans un élément de tableau de bord. Un exemple représentatif de son utilisation est fourni sur la page de documentation des éléments de graphique à colonnes.

Chaque déclaration name crée un filtre de tableau de bord et lui attribue un nom. Le nom sera référencé dans le paramètre listen des éléments qui doivent être concernés par le filtre. Le paramètre listen s'applique à tous les types d'éléments, à l'exception de type: text. Vous trouverez des informations sur son utilisation sur les pages de documentation pour chaque type de visualisation. Pour obtenir un exemple représentatif du fonctionnement de listen, consultez la page de documentation Paramètres des graphiques à barres pour les tableaux de bord LookML.

filters:
- name: order_date

title (pour les filtres)

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

title peut également être utilisé dans un tableau de bord, comme décrit dans la section title (pour les tableaux de bord) de cette page.

title peut également être utilisé dans un élément de tableau de bord. Un exemple représentatif de son utilisation est fourni sur la page de documentation Paramètres des graphiques à barres pour les tableaux de bord LookML.

Le paramètre title vous permet de modifier la façon dont le nom d'un filtre s'affiche pour les utilisateurs en haut d'un tableau de bord. Si ce paramètre n'est pas spécifié, le titre est défini par défaut sur le nom du filtre.

Considérez l'exemple suivant :

filters:
- name: order_date
  title: "Order Date(s)"

Si vous avez effectué cette opération, le filtre Date de la commande s'affichera sous la forme Date(s) de la commande.

type

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

type peut également être utilisé dans un élément de tableau de bord, comme décrit sur la page de documentation du paramètre type (pour les tableaux de bord LookML).

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

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 spécifie le type d'entrée qui sera placé dans le filtre. Bien que tout type de saisie (comme une date) puisse être saisi dans le filtre type: string_filter, être plus précis permet de fournir à l'utilisateur un widget de filtre plus adapté. Voici les quatre types de filtres :

  • field_filter : il s'agit généralement de votre choix par défaut lorsque vous pouvez spécifier une dimension ou une mesure sous-jacente. Si vous utilisez type: field_filter et associez le filtre à un champ type:string, le filtre suggère des valeurs possibles.
  • number_filter : permet à l'utilisateur de saisir une valeur numérique/entière ou une expression.
  • date_filter : permet à l'utilisateur de saisir une valeur ou une expression de date.
  • string_filter : permet à l'utilisateur de saisir du texte libre.

field_filter

Suggère des options au choix et modifie sa présentation aux utilisateurs en fonction du champ sous-jacent que vous spécifiez.

Il s'agit du type de filtre à privilégier lorsque vous souhaitez faire des suggestions aux utilisateurs lorsqu'ils interagissent avec le filtre. La dimension à partir de laquelle les suggestions seront extraites est définie à l'aide des paramètres explore et field. Pour générer des suggestions de filtres, elle doit être un champ de type: string.

Il est possible que les suggestions ne fonctionnent pas si le champ provient d'une table dérivée, si sql_always_where est utilisé dans l'exploration ou si le champ est une mesure.

filters:
- name: order_date
  type: field_filter
  explore: orders
  field: orders.order_date  # must be of the form view_name.dimension_name

number_filter

Ne fait pas de suggestions, permet à l'utilisateur de saisir une valeur ou une expression numérique.

filters:
- name: order_value
  type: number_filter

date_filter

Ne fait pas de suggestions, permet à l'utilisateur de saisir une valeur ou une expression de date.

filters:
- name: order_date
  type: date_filter

string_filter

Ne fait pas de suggestions, permet à l'utilisateur de saisir du texte libre.

filters:
- name: customer_name
  type: string_filter

default_value

Le paramètre default_value vous permet de spécifier une valeur par défaut à utiliser pour un filtre. Cette valeur peut être utile aux utilisateurs en leur suggérant un point de départ raisonnable.

Veillez à ce que la valeur par défaut corresponde au type de filtre utilisé. Exemple :

filters:
- name: order_value
  type: number_filter
  default_value: "50 to 100"

- name: order_date
  type: date_filter
  default_value: "last 30 days"

- name: customer_name
  type: string_filter
  default_value: "John Doe"

Vous pouvez utiliser des expressions de filtre pour créer des valeurs par défaut. Pour en savoir plus, consultez la page de documentation sur les expressions de filtre Looker.

Lorsque vous utilisez à la fois les paramètres default_value et ui_config, les expressions de filtre doivent être compatibles avec la valeur attribuée au sous-paramètre type de ui_config et avec les types de données compatibles avec la valeur type.

Vous pouvez également utiliser les variables Liquid _localization et _user_attributes pour des valeurs de filtre par défaut flexibles.

allow_multiple_values

Le paramètre allow_multiple_values vous permet de contrôler si les utilisateurs peuvent sélectionner une ou plusieurs valeurs de filtre. Lorsque ce paramètre est défini sur true (valeur par défaut), les utilisateurs peuvent sélectionner plusieurs valeurs pour le filtre. Lorsque ce paramètre est défini sur false, les utilisateurs ne peuvent sélectionner qu'une seule valeur de filtre.

Exemple :

filters:
- name: Order ID
  title: Order ID
  type: field_filter
  allow_multiple_values: true
  required: false
  model: thelookstore
  explore: orders
  field: orders.id

required

Le paramètre required vous permet d'exiger des utilisateurs qu'ils fournissent une valeur pour le filtre afin d'exécuter le tableau de bord. Par défaut, les valeurs de filtres ne sont pas obligatoires. Si un filtre n'exigeant aucune valeur est laissé vide, les données ne sont simplement pas limitées par le champ de filtrage. Si un filtre nécessitant une valeur est laissé vide, le tableau de bord n'est pas exécuté.

filters:
  - name: State
    title: State
    type: field_filter
    required: true

ui_config

Le sous-paramètre ui_config de filters vous permet de configurer les paramètres de filtre pour un tableau de bord LookML. Ces paramètres incluent les types de commandes de filtrage utilisées, leur emplacement et les valeurs de filtre possibles.

Exemple :


  filters:
  - name: City
    title: City
    type: field_filter
    default_value: San Francisco
    allow_multiple_values: true
    required: false
    ui_config:
      type: button_group
      display: inline
      options:
      - San Francisco
      - New York
      - Tokyo
    model: thelook
    explore: order_items
    field: users.city

Pour savoir comment configurer des filtres avec l'UI, consultez la page de documentation Ajouter et modifier des filtres de tableaux de bord définis par l'utilisateur.

type

Le sous-paramètre type de ui_config vous permet de spécifier les types de commandes de filtrage qui s'affichent.

En fonction de la valeur que vous saisissez pour type, les commandes de filtrage peuvent être à sélection unique ou multiple.

Les valeurs acceptées par type dépendent du type LookML attribué au champ sur lequel vous appliquez le filtre.

STR : compatible avec le type de données string DIST = Compatible avec le type de données distance
NUM : compatible avec le type de données number et les mesures numériques DUR : compatible avec le type de données duration
TIER = Compatible avec le type de données tier D&T : compatible avec la plupart des types de données date et heure
ZIP : compatible avec le type de données zipcode LOC : compatible avec le type de données location
O/N = Compatible avec le type de données yesno PAR = Compatible avec le paramètre parameter
ValeurDescriptionTypes de données acceptés
Sélection multiple
button_group Le filtre affiche un groupe de boutons, un pour chaque valeur spécifiée avec le paramètre options. STR NUM TIER ZIP Y/N DIST DUR
checkboxes Le filtre affiche des cases à cocher, une pour chaque valeur spécifiée avec le paramètre options. STR NUM TIER ZIP Y/N DIST DUR
tag_list Le filtre affiche un menu déroulant listant chaque valeur possible spécifiée à l'aide du paramètre options. STR NUM TIER ZIP DIST DUR
range_slider Pour les champs numériques, le filtre affiche un curseur qui permet aux utilisateurs de définir une plage de nombres comme valeur du filtre. Les sous-paramètres min et max de options permettent de spécifier les valeurs minimale et maximale possibles pour le filtre. La plage par défaut peut être spécifiée à l'aide du paramètre default_value. NUM DIST DUR
Sélection unique
button_toggles Le filtre affiche un groupe de boutons, un pour chaque valeur spécifiée avec le paramètre options. STR NUM TIER ZIP Y/N DIST DUR PAR
radio_buttons Le filtre affiche des cases d'option, avec un bouton pour toutes les valeurs et un bouton pour chaque valeur spécifiée avec le paramètre options. STR NUM TIER ZIP Y/N DIST DUR PAR
dropdown_menu Le filtre affiche un menu déroulant listant chaque valeur possible spécifiée à l'aide du paramètre options. Le menu déroulant permet également aux utilisateurs de sélectionner l'option Toute valeur. STR NUM TIER ZIP Y/N DIST DUR PAR
slider Pour les champs numériques, le filtre affiche un curseur qui permet aux utilisateurs de choisir un filtre en le faisant glisser entre les valeurs minimale et maximale possibles, qui sont spécifiées à l'aide du paramètre options. NUM DIST DUR
Dates et heures
day_picker Ce filtre permet aux utilisateurs de choisir une date spécifique sur laquelle filtrer les données. Date et heure : le sélecteur de jour unique peut être utilisé avec la plupart des périodes et des types basés sur le temps, mais les lecteurs ne peuvent sélectionner que des dates uniques avec ce type de sélecteur.
day_range_picker Le filtre permet aux utilisateurs de sélectionner une date de début et une date de fin pour filtrer une plage de dates. Période et type : le sélecteur de plage de dates peut être utilisé avec la plupart des périodes et des types basés sur le temps, mais les lecteurs ne peuvent sélectionner que des plages de dates avec ce type de sélecteur.
date_time_range_input Le filtre permet à l'utilisateur de filtrer les données selon une plage de dates et d'heures. Date et heure : le sélecteur de plage de dates et d'heures peut être utilisé avec la plupart des types basés sur le temps. Les lecteurs doivent sélectionner les options de date et d'heure avec ce type de sélecteur.
relative_timeframes Il permet à l'utilisateur de filtrer les données sur une plage de dates personnalisée ou de choisir parmi des périodes prédéfinies telles que Aujourd'hui, 7 derniers jours ou 90 derniers jours. Période et type : le sélecteur de période peut être utilisé avec la plupart des périodes et des types basés sur le temps, mais les lecteurs ne peuvent pas sélectionner d'options temporelles avec ce type de sélecteur.
Autre
advancedLe filtre propose des options permettant d'appliquer un ou plusieurs filtres ou filtres de correspondances avancées.

Pour en savoir plus sur les paramètres avancés, consultez la section Utiliser les paramètres avancés sur cette page. 		STR NUM TIER ZIP Y/N D&T DIST DUR LOC PAR

display

Vous pouvez utiliser le sous-paramètre display de ui_config pour définir la position d'un filtre de tableau de bord. Vous pouvez positionner un filtre en attribuant l'une des valeurs suivantes à display :

  • inline : le filtre est affiché directement dans la barre supérieure du tableau de bord.
  • popover : une valeur récapitulative s'affiche dans la barre supérieure du tableau de bord. Cliquez sur la valeur pour voir le filtre complet.
  • overflow : un bouton Plus apparaît dans la barre supérieure du tableau de bord avec un indicateur numérique correspondant au nombre de filtres supplémentaires. Les utilisateurs peuvent cliquer sur le bouton pour voir les filtres et leurs valeurs.

Certains types de filtres ne peuvent être affichés que de certaines manières. Par exemple, les filtres type: day_picker ne peuvent être affichés que sous la forme inline ou overflow. Si vous attribuez à un filtre une valeur display non valide pour le type, le filtre s'affichera sous la forme inline ou popover, selon ce qui est valide. Pour en savoir plus, consultez la page de documentation Ajouter et modifier des filtres de tableaux de bord définis par l'utilisateur.

Pour savoir comment positionner les filtres de tableau de bord à l'aide de l'UI, consultez la page de documentation Ajouter et modifier des filtres définis par l'utilisateur.

options

Le sous-paramètre facultatif options de ui_config vous permet de spécifier les valeurs qu'un utilisateur peut choisir pour mettre à jour temporairement les valeurs de filtre d'un tableau de bord lorsqu'il consulte un tableau de bord LookML. Si vous ne spécifiez aucune valeur pour options, Looker extrait les premières valeurs de la base de données.

Par exemple, vous pouvez définir San Francisco, New York et Tokyo comme valeurs possibles pour un filtre sur le champ users.city comme suit :


ui_config:
  type: button_group
  display: inline
  options:
  - San Francisco
  - New York
  - Tokyo

Si le sous-paramètre type de ui_config est défini sur range_slider ou slider, vous pouvez utiliser les sous-paramètres min et max de options :

  • min : définit la valeur minimale possible pour un filtre.
  • max : définissez la valeur maximale possible pour un filtre.

Exemple :


ui_config:
  type: range_slider
  display: inline
  options:
    min: 0
    max: 500

model

Pour les filtres de tableau de bord de type type: field_filter, vous devez définir un modèle à partir duquel le filtre extraira les suggestions. Le paramètre model spécifie le modèle contenant le champ que vous souhaitez utiliser.

filters:
- name: State
  title: State
  type: field_filter
  default_value: California
  model: thelookstore
  explore: users
  field: users.state

explore

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

explore peut également être utilisé dans un modèle, comme décrit sur la page de documentation du paramètre explore.

explore peut également être utilisé dans un élément de tableau de bord. Un exemple représentatif de son utilisation est fourni sur la page de documentation des éléments de graphique à colonnes.

Pour les filtres de tableau de bord de type type: field_filter, vous devez définir un champ à partir duquel le filtre extraira les suggestions. Le paramètre explore spécifie l'exploration contenant le champ que vous souhaitez utiliser.

filters:
- name: order_date
  type: field_filter
  explore: orders
  field: orders.order_date

field

Pour les filtres de tableau de bord de type type: field_filter, vous devez définir un champ à partir duquel le filtre extraira les suggestions. Le paramètre field spécifie le champ que vous souhaitez utiliser. Il est important d'utiliser le nom de champ complet. En d'autres termes, utilisez view_name.field_name et pas seulement field_name.

filters:
- name: order_date
  type: field_filter
  explore: orders
  field: orders.order_date

listens_to_filters

Pour les filtres de tableau de bord de type type: field_filter, vous pouvez affiner les suggestions de filtre en fonction de ce que l'utilisateur saisit pour un autre filtre de type type: field_filter.

Dans l'exemple suivant, les suggestions fournies pour le filtre State seront basées sur les valeurs du filtre Order ID. Toutes les valeurs sélectionnées pour le filtre Order ID seront associées à des valeurs users.state. Ces valeurs seront suggérées pour le filtre State. Pour en savoir plus, consultez la page de documentation Ajouter et modifier des filtres de tableaux de bord définis par l'utilisateur.

filters:
- name: State
  title: State
  type: field_filter
  model: thelookstore
  explore: users
  listens_to_filters:
  - Order ID
  field: users.state

embed_style

Le paramètre embed_style lance la section de code LookML dans laquelle vous personnalisez l'apparence d'un tableau de bord intégré. embed_style et ses paramètres associés ne sont compatibles qu'avec les tableaux de bord intégrés. Ils sont ignorés si le tableau de bord n'est pas intégré.

Après avoir modifié embed_style, vous devez déployer votre LookML en production pour que vos paramètres embed_style soient reflétés dans le tableau de bord LookML intégré.

Pour les attributs de tableau de bord intégrés suivants qui spécifient une couleur, la valeur de couleur peut être une chaîne hexadécimale comme #2ca6cd ou une chaîne de couleur nommée CSS comme mediumblue.

Les personnalisations de tableaux de bord intégrés se présentent sous la forme suivante :

embed_style:
  background_color: "css_color"
  show_title: true | false
  title_color: "css_color"
  show_filters_bar: true | false
  tile_background_color: "css_color"
  tile_text_color: "css_color"

background_color

Définit la couleur de l'arrière-plan d'un tableau de bord intégré.

embed_style:
  background_color: "#ffffff"

show_title

Indique si le titre du tableau de bord intégré est visible par les utilisateurs.

embed_style:
  show_title: false

title_color

Définit la couleur du titre d'un tableau de bord intégré.

embed_style:
  title_color: "#008000"

show_filters_bar

Indique si les filtres du tableau de bord intégré sont visibles par les utilisateurs.

Ce paramètre n'affecte que l'apparence du tableau de bord, et non la capacité d'un utilisateur à accéder aux données. Masquer la barre de filtres n'empêche PAS les utilisateurs de modifier les filtres par d'autres moyens. Pour savoir comment configurer des stratégies de contrôle d'accès aux données sécurisées, consultez la page de documentation Contrôle des accès et gestion des autorisations.

embed_style:
  show_filters_bar: true

tile_background_color

Définit la couleur de l'arrière-plan de toutes les tuiles d'un tableau de bord intégré.

embed_style:
  tile_background_color: "lightyellow"

tile_text_color

Définit la couleur du texte sur toutes les vignettes d'un tableau de bord intégré.

embed_style:
  tile_text_color: "crimson"

elements

Cette section fait référence au paramètre elements qui fait partie d'un dashboard.

elements peut également être utilisé dans une ligne de tableau de bord, comme décrit dans la section elements pour les lignes de cette page.

Le paramètre elements marque le début de la section LookML dans laquelle vous définissez les éléments qui composeront un tableau de bord. De nombreux paramètres peuvent définir l'apparence d'un élément de tableau de bord. Ils sont décrits plus en détail sur la page Paramètres des éléments du tableau de bord.

- dashboard: sales_overview
  layout: tile
  elements:
  - name: order_count
    type: single_value
    model: ecommerce
    explore: orders
    measures: [orders.count]

Réfléchissez au nombre et à la complexité des éléments que vous allez ajouter au tableau de bord LookML. Plus le nombre d'éléments est important, plus les ressources du navigateur sont sollicitées, ce qui augmente le temps nécessaire à la réalisation du rendu du tableau de bord. De même, les éléments qui affichent de grandes quantités de données peuvent avoir un impact sur les performances du tableau de bord. Si le rendu pose problème, il est préférable de réduire la complexité des requêtes d'éléments de tableau de bord ou de créer plusieurs tableaux de bord avec moins d'éléments.