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 et sont décrits sur la page de documentation Créer des tableaux de bord définis par l'utilisateur. Les tableaux de bord peuvent également être créés à l'aide de LookML, et leurs paramètres généraux peuvent être modifiés comme décrit 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 tuiles de texte, les boutons et les groupes de tuiles du tableau de bord. Consultez la page Paramètres des éléments de tableau de bord pour obtenir des liens vers les pages de référence de chaque type d'élément.

Exemple d'utilisation

- dashboard: dashboard_name
  title: "chosen dashboard title"
  description: "chosen dashboard description"
  enable_viz_full_screen: true | false
  enabled_dashboard_agents: true | false
  default_dashboard_agent: agent_name
  extends: name_of_dashboard_being_extended
  extension: required
  layout: tile | static | grid | newspaper
  tabs:
  - name: Tab 1
    label: Tab 1
  - name: Tab 2
    label: Tab 2
  - name: Tab 3
    label: Tab 3
  - name: Tab 4
    label: Tab 4
  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
    model: model_name
    explore: explore_name
    field: view_name.field_name
    default_value: Looker filter expression
    allow_multiple_values: true | false
    required: true | false
    vis_filter: 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
  tab_name:
  # Optional - for organizing elements onto tabs. Must be declared for each element individually.
  group:
  # Optional - for organizing elements into a tile group. Must be declared for each child element individually.

Définition des paramètres

Nom du paramètre	Description
dashboard	Créer un tableau de bord
title (pour le tableau de bord)	Modifie la présentation d'un nom de tableau de bord 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 définis en sous forme de liste.
enable_viz_full_screen	Déterminez si les utilisateurs du tableau de bord peuvent voir les vignettes du tableau de bord en plein écran et en vue développée.
enabled_dashboard_agents	Définissez si les utilisateurs du tableau de bord peuvent discuter avec le tableau de bord LookML à l'aide d'un agent de tableau de bord.
default_dashboard_agent	Spécifiez l'agent de tableau de bord par défaut à utiliser pour les requêtes conversationnelles sur le tableau de bord.
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.
tabs	Ajout de la version 26.4 Ajout d'onglets de tableau de bord pour organiser les éléments d'un tableau de bord. Doit être utilisé avec le paramètre tab_name pour les éléments afin de spécifier l'onglet dans lequel un élément apparaîtra.
rows	Marquez le début d'une section de code LookML pour définir les éléments de 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 être exécutés 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	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	Définissez l'emplacement de la barre de filtres du tableau de bord sur En haut ou À droite.
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)	Modifie la présentation d'un nom de filtre pour les utilisateurs.
type (pour les filtres)	Déterminez le type de filtre à utiliser.
default_value	Définir une valeur par défaut pour un filtre.
allow_multiple_values	Limiter les utilisateurs à une seule valeur de filtre.
required	Exiger que les utilisateurs saisissent 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)	(Facultatif) Spécifiez le modèle qui contient le champ sous-jacent d'un filtre type: field_filter.
explore (pour les filtres)	Spécifiez 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 pour les filtres de tableau de bord de field_filter en fonction de ce que l'utilisateur saisit pour un autre filtre de tableau de bord de type: field_filter.
vis_filter	Configurez un filtre pour qu'il s'affiche directement sur une tuile de visualisation plutôt que dans la barre de filtres du tableau de bord.
Paramètres du tableau de bord intégré
embed_style	Marque le début d'une section de code LookML pour définir les personnalisations d'un tableau de bord intégré.
background_color	Définissez une couleur d'arrière-plan pour 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 vignettes d'un tableau de bord intégré.
Paramètres de l'élément
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.
group (pour les éléments)	Organisez les éléments du tableau de bord en un groupe de tuiles en spécifiant le nom d'un élément type: group.

dashboard

Le paramètre dashboard déclare un nouveau tableau de bord et spécifie un nom pour celui-ci. 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 quelque chose, un tableau de bord nécessite l'ajout d'au moins un élément à l'aide du paramètre elements.

Remarque : Si vous modifiez la valeur du paramètre dashboard d'un tableau de bord LookML qui a été déplacé du dossier Tableaux de bord LookML, le tableau de bord LookML sera automatiquement replacé dans le dossier Tableaux de bord LookML.

preferred_viewer (obsolète)

Important : Ce paramètre est ignoré.

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, soit l'expérience de tableau de bord par défaut de Looker, soit un ancien tableau de bord.

title (pour le tableau de bord)

Remarque : 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 du tableau de bord. Un exemple représentatif de son utilisation est fourni sur la page de documentation Éléments d'un 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 ce paramètre n'est pas spécifié, le titre par défaut est le nom du tableau de bord. Le texte du titre peut être localisé.

Considérez l'exemple suivant :

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

Si vous procédez ainsi, le tableau de bord n'apparaîtra pas sous le nom Sales Overview, mais sous le nom 1) Sales Overview.

description (pour le tableau de bord)

Remarque : 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 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 sous forme de 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 en plein écran est activé par défaut.

Le paramètre enable_viz_full_screen vous permet de définir si les utilisateurs qui consultent le tableau de bord peuvent voir les vignettes du tableau 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 étendues disponibles) et false (vues plein écran et étendues non disponibles). La valeur par défaut est true.

enabled_dashboard_agents

Le paramètre enabled_dashboard_agents vous permet de contrôler si les utilisateurs d'un tableau de bord LookML peuvent discuter avec celui-ci à l'aide d'un agent de tableau de bord.

Ce paramètre ne prend effet que lorsque le paramètre Agents de tableau de bord est activé pour votre instance Looker sur la page d'administration Gemini dans Looker.

Ce paramètre accepte true (chat activé) et false (chat désactivé). Si ce paramètre est omis dans le fichier du tableau de bord LookML, il est défini par défaut sur true au niveau de la couche d'API.

- dashboard: sales_overview
  enabled_dashboard_agents: true

default_dashboard_agent

Le paramètre default_dashboard_agent spécifie le nom de l'agent de tableau de bord par défaut à associer au tableau de bord LookML. L'agent spécifié doit être déclaré à l'aide du paramètre LookML agent.

Lorsque les utilisateurs qui consultent le tableau de bord démarrent une conversation avec celui-ci, les paramètres de l'agent par défaut, tels que le mode de réflexion et l'affichage des informations de débogage, sont appliqués à la conversation.

- dashboard: sales_overview
  default_dashboard_agent: sales_overview_agent

Si enabled_dashboard_agents est défini sur true et que default_dashboard_agent n'est pas spécifié, les utilisateurs peuvent toujours discuter avec le tableau de bord en utilisant les paramètres par défaut sans instructions personnalisées.

extends

Comme décrit sur la page de documentation Réutiliser du code avec des extensions, 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.

Attention : 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 de nouvelles 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 Localiser 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 basé sur 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 qui sont 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. Les valeurs suivantes sont acceptées :

• newspaper : les éléments du tableau de bord s'afficheront dans une grille de 24 colonnes. La taille par défaut d'un élément est de huit colonnes de largeur et de six lignes de hauteur. Les éléments sont configurables le long de cette grille, spécifiée par les paramètres d'élément width, height, row et col. Cette option de mise en page est utilisée lorsqu'un tableau de bord défini par l'utilisateur est converti en tableau de bord LookML. Il s'agit également de la mise en page par défaut lorsqu'un tableau de bord LookML est créé via l'IDE Looker. newspaper est la seule mise en page compatible avec les onglets de tableau de bord et les groupes de tuiles. De plus, newspaper et grid sont les seules mises en page compatibles avec la conversion d'un tableau de bord LookML en tableau de bord défini par l'utilisateur.

• grid : les éléments du tableau de bord s'affichent avec des largeurs dynamiques, qui sont basées sur un ensemble de lignes que vous définissez avec le paramètre rows et ses sous-paramètres elements et height. newspaper et grid sont les seules mises en page compatibles avec la conversion d'un tableau de bord LookML en tableau de bord défini par l'utilisateur.

• static : les éléments du tableau de bord s'affichent dans l'ordre dans lequel ils sont listés dans le fichier LookML. Chaque élément du tableau de bord doit être positionné manuellement à l'aide des paramètres top et left. Ces paramètres s'appliquent à tous les types d'éléments. Pour en savoir plus sur leur utilisation, consultez les pages de documentation de chaque type de visualisation. Pour obtenir des exemples représentatifs du fonctionnement de top et left, consultez la page de documentation Paramètres des graphiques à colonnes pour les tableaux de bord LookML. static ne permet pas de convertir un tableau de bord LookML en tableau de bord défini par l'utilisateur.

• tile : les éléments du tableau de bord s'affichent dans l'ordre dans lequel ils sont listés dans le fichier LookML. La largeur du tableau de bord est dynamique et dépend de la largeur du navigateur. Les éléments du tableau de bord se positionnent de manière dynamique dans le navigateur pour remplir l'espace disponible. tile ne permet pas de convertir un tableau de bord LookML en tableau de bord défini par l'utilisateur.

tabs

Ajout d'onglets pour organiser les éléments sur les tableaux de bord. tabs définit le nombre, les noms et les libellés des onglets qui s'affichent dans les tableaux de bord. Les éléments sont organisés dans les onglets du tableau de bord à l'aide du paramètre tab_name.

Important : Les tableaux de bord à onglets ne sont compatibles qu'avec la méthode de mise en page de tableau de bord newspaper.

- dashboard: sales_overview
  layout: tile
  tabs:
  - name: Tab 1
    label: Tab 1
  - name: Tab 2
    label: Tab 2
  - name: Tab 3
    label: Tab 3
  - name: Tab 4
    label: Tab 4

tab_name

Spécifie l'onglet du tableau de bord dans lequel un élément apparaîtra. tab_name doit être spécifié pour chaque élément individuel.

- dashboard: sales_overview
  layout: tile
  tabs:
  - name: Tab 1
    label: Tab 1
  - name: Tab 2
    label: Tab 2
  - name: Tab 3
    label: Tab 3
  - name: Tab 4
    label: Tab 4
  elements:
  - name: order_count
    type: single_value
    model: ecommerce
    explore: orders
    measures: [orders.count]
    tab_name: Tab 1

rows

Pour les tableaux de bord layout: grid, le paramètre rows marque le début de la section de code LookML où vous définissez les éléments à placer dans chaque ligne, ainsi que la hauteur de chaque ligne. Dans chaque ligne, chaque élément a la même largeur. Si vous n'indiquez 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 du tableau de bord, séparés par une virgule. Chaque déclaration elements crée une ligne dans le tableau de bord. Les éléments placés dans une ligne auront tous la même largeur. Ainsi, si vous placez deux éléments sur une ligne, ils occuperont chacun 50 % de l'espace disponible. Si vous placez quatre éléments sur une ligne, ils occuperont chacun 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 des tuiles. 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 aura une hauteur de 500 pixels et une largeur de 300 pixels. 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 de 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 à colonnes pour les tableaux de bord LookML.

width

Remarque : 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 de 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 limite pas le tableau de bord à une certaine taille si vous définissez un élément trop grand ou trop d'éléments sur une ligne. Le paramètre width permet plutôt de maintenir le tableau de bord centré sur 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

Remarque : 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 des données actualisées. Cette fonctionnalité est souvent utile dans les environnements où un tableau de bord est affiché en permanence, 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échauffer" le cache du tableau de bord.

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

- dashboard: sales_overview
  refresh: 2 hours

Soyez prudent lorsque vous définissez des intervalles d'actualisation courts. Comme les tableaux de bord peuvent contenir de nombreuses requêtes, dont certaines peuvent être gourmandes en ressources, certains tableaux de bord peuvent solliciter fortement 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écute automatiquement lorsqu'il est ouvert :

- 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 de filtre. Cela permet d'éviter les actualisations indésirables lorsqu'un utilisateur fait une pause pendant la modification d'un 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 utilisateurs du tableau 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 du tableau de bord peuvent développer la barre de filtres en cliquant sur l'icône de filtres. La valeur par défaut de ce paramètre 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 d'un tableau de bord. 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 du tableau de bord. La valeur par défaut de ce paramètre est true.

- dashboard: sales_data
  filters_location_top: false

filters

Remarque : 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 de code LookML où vous définissez les filtres du tableau de bord. Les filtres s'affichent en haut du tableau de bord et permettent aux utilisateurs de modifier les données derrière les é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, type: button et type: group. Pour obtenir un exemple représentatif du fonctionnement de listen, consultez la page de documentation Paramètres des graphiques à colonnes pour les tableaux de bord LookML.

Remarque : Pour les éléments de tableau de bord qui utilisent le paramètre merged_queries, chaque requête source peut écouter un ou plusieurs filtres de tableau de bord. Dans une définition de requête fusionnée, vous pouvez utiliser le paramètre listen pour définir la logique de filtrage de chaque requête source indépendamment, quel que soit le nombre de requêtes sources dans votre élément de résultats fusionnés. Si une requête ne comporte pas de paramètre listen, elle ne sera pas affectée par les filtres du tableau de bord.

Lorsque des filtres sont appliqués à un élément de cette manière, le type de filtre doit correspondre au type de dimension ou de mesure qui écoute le filtre (pour en savoir plus, consultez Créer des tableaux de bord LookML).

Remarque : Ne définissez pas plusieurs filtres avec la même combinaison de name et title dans un tableau de bord LookML. La validation LookML ne signale pas cette configuration en double, et le tableau de bord s'affiche normalement. Toutefois, la duplication entraîne l'échec des opérations "Copier le tableau de bord LookML" et "Importer le tableau de bord" avec une erreur (par exemple, "Échec de la copie du tableau de bord"). Si vous rencontrez ce problème, examinez la définition LookML du tableau de bord pour vérifier que toutes les configurations de nom et de titre de filtre sont uniques.

Les filtres se présentent sous la forme suivante :

filters:
- name: filter_name
  title: "chosen filter title"
  type: field_filter | number_filter | date_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
  vis_filter: true | false
  listens_to_filters:
  - filter_name
    field: view_name.field_name

name

Remarque : 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 affectés par le filtre. Le paramètre listen s'applique à tous les types d'éléments, à l'exception de type: text, type: button et type: group. Des informations détaillées sur son utilisation sont disponibles sur les pages de documentation de chaque type de visualisation. Pour obtenir un exemple représentatif du fonctionnement de listen, consultez la page de documentation Paramètres des graphiques à colonnes pour les tableaux de bord LookML.

filters:
- name: order_date

title (pour les filtres)

Remarque : 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 un tableau 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 à colonnes pour les tableaux de bord LookML.

Le paramètre title vous permet de modifier l'affichage du nom d'un filtre pour les utilisateurs en haut d'un tableau de bord. Si ce paramètre n'est pas spécifié, le titre par défaut est le nom du filtre.

Considérez l'exemple suivant :

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

Si vous avez procédé ainsi, le filtre s'affiche sous la forme Order Date(s) (Date(s) de commande) au lieu de Order Date (Date de commande).

type

Remarque : 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 le cadre d'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. type: field_filter doit généralement être votre choix par défaut, car il connecte directement le filtre à une dimension ou une mesure sous-jacente, et fournit un widget de filtre personnalisé à l'utilisateur. Les types de filtres sont les suivants :

• field_filter : il s'agit généralement du choix par défaut lorsque vous pouvez spécifier une dimension ou une mesure sous-jacente. En utilisant type: field_filter et en associant le filtre à un champ type:string, le filtre suggère des valeurs de filtre possibles.
• number_filter : permet à l'utilisateur de saisir un nombre, une valeur entière ou une expression.
• date_filter : permet à l'utilisateur de saisir une valeur de date ou une expression.

• string_filter (obsolète) : le type string_filter n'est plus pris en charge depuis que l'ancienne expérience des tableaux de bord a été abandonnée dans Looker 23.6 (pour en savoir plus, consultez les notes de version). Si vous souhaitez un filtre de saisie de texte libre sans liste déroulante de suggestions, consultez l'exemple utilisant field_filter.

field_filter

Suggère des options parmi lesquelles choisir, 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 proposer 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. Elle doit être un champ de type: string pour générer des suggestions de filtres.

Les suggestions peuvent ne pas fonctionner 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.

Voici un exemple de LookML pour un type field_filter :

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

Si vous souhaitez un filtre de saisie de texte libre sans liste déroulante de suggestions, utilisez type: field_filter, puis configurez le type de commande à l'aide de ui_config: type: advanced (voir UI config).

L'exemple suivant montre un filtre qui utilise une saisie de texte libre sans suggestions :

filters:
- name: customer_name
  type: field_filter
  explore: orders
  field: customer.name
  ui_config:
    type: advanced

number_filter

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

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

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 à faire correspondre la valeur par défaut 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: field_filter
  explore: orders
  field: customer.name
  default_value: "John Doe"

Vous pouvez utiliser des expressions de filtre pour créer des valeurs par défaut. La page de documentation Expressions de filtre Looker décrit ce point plus en détail.

Lorsque vous utilisez 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 les types de données compatibles avec la valeur type.

Vous pouvez également utiliser les variables Liquid _localization et _user_attributes pour définir 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 seule valeur de filtre ou plusieurs. 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 que les utilisateurs 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 ne s'exécute pas.

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 d'un tableau de bord LookML. Ces paramètres incluent les types de commandes de filtre utilisés, l'emplacement des commandes de filtre 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 en savoir plus sur la configuration des filtres avec l'interface utilisateur, 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.

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

Remarque : Les valeurs acceptées par type dépendent du type de données LookML attribué au champ sur lequel vous filtrez.

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
Y/N = compatible avec le type de données yesno	PAR = compatible avec le paramètre parameter

Valeur	Description	Types de données acceptés
Sélection multiple
button_group	Le filtre affiche un groupe de boutons, avec un bouton 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 une liste déroulante de 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, et 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, avec un bouton 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 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 faisant glisser le curseur 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	Le filtre permet aux utilisateurs de choisir une date spécifique pour filtrer les données.	D&T 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 sur une plage de dates. Remarque : Lorsqu'un tableau de bord LookML est chargé via un favori du navigateur, les commandes de filtre configurées avec type: day_range_picker ne conservent pas et n'affichent pas correctement les paramètres d'URL et l'état du filtre (par exemple, la date de fin est décalée d'un jour dans l'interface utilisateur). Pour résoudre ce problème d'affichage, modifiez la définition LookML du filtre en remplaçant le type ui_config par advanced. Consultez l'exemple ci-dessous : ui_config: type: advanced display: inline	D&T 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 les plages de dates qui disposent de ce type de commande.
date_time_range_input	Le filtre permet à l'utilisateur de filtrer sur une plage de dates et d'heures.	D&T : 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	Le filtre permet à l'utilisateur de filtrer 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.	D&T : la commande de période peut être utilisée avec la plupart des périodes et des types temporels, mais les lecteurs ne peuvent pas sélectionner d'options temporelles avec ce type de commande.
Autre
advanced	Le filtre présente des options permettant d'appliquer un ou plusieurs filtres ou filtres de type correspondances avancées. Pour en savoir plus sur les commandes avancées, consultez la section Utiliser les commandes avancées de cette page.	STR NUM TIER ZIP Y/N D&T DIST DUR LOC PAR

Remarque : Certains intervalles de temps et types temporels sont interprétés comme des types de données différents lorsque Looker crée des options de contrôle pour eux. Par exemple, le intervalle de temps yesno est interprété comme un type de données yesno et accepte donc les valeurs compatibles avec le type yesno. De même, l'intervalle de temps hour_of_day est interprété comme un type de données number et accepte donc les valeurs compatibles avec le type number.

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. 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 de type: day_picker ne peuvent être affichés que sous la forme inline ou overflow. Si vous attribuez à un filtre une valeur display qui n'est pas valide pour ce type, le filtre s'affichera sous la forme inline ou popover, selon la valeur 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 en savoir plus sur le positionnement des filtres de tableau de bord à l'aide de l'interface utilisateur, 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 parmi lesquelles un utilisateur peut choisir pour mettre à jour temporairement les valeurs des filtres de 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éfinissez 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: field_filter, le paramètre model définit le modèle du champ que vous souhaitez utiliser. Le paramètre model est facultatif et correspond par défaut au modèle dans lequel le tableau de bord est inclus.

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

explore

Remarque : 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 le cadre d'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 des suggestions. Le paramètre explore spécifie l'exploration qui contient 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 des 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: field_filter, vous pouvez affiner les suggestions du filtre en fonction de ce que l'utilisateur saisit pour un autre filtre de type: field_filter.

Dans l'exemple suivant, les suggestions fournies pour le filtre State seront basées sur les valeurs du filtre Order ID. Les valeurs sélectionnées pour le filtre Order ID seront associées à des valeurs users.state, qui 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

vis_filter

Remarque : Cette fonctionnalité est disponible en version preview.

Le paramètre vis_filter vous permet de configurer un filtre en tant que filtre au niveau de la visualisation qui apparaît directement sur les vignettes de visualisation individuelles plutôt que dans la barre de filtres supérieure du tableau de bord.

Lorsque vis_filter est défini sur true, le filtre s'affiche dans la barre de filtres en haut de chaque tuile qui l'écoute (configurée à l'aide du paramètre listen sur l'élément du tableau de bord). La valeur par défaut est false, ce qui affiche le filtre en tant que filtre standard au niveau du tableau de bord dans la barre de filtres supérieure. Il n'est pas nécessaire de définir vis_filter: false pour les filtres de tableau de bord standards.

Exemple :

filters:
- name: order_date
  title: "Order Date"
  type: date_filter
  default_value: "last 30 days"
  vis_filter: true

Pour en savoir plus sur les filtres au niveau de la visualisation, consultez la page de documentation Filtres sur les tuiles de visualisation.

embed_style

Le paramètre embed_style marque le début de 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 et 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é 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 des 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.

Remarque : 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 règles de contrôle d'accès sécurisé aux donné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 d'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

Remarque : 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 de code LookML où 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 de tableau de bord.

- dashboard: sales_overview
  layout: tile
  tabs:
  - name: Tab 1
    label: Tab 1
  - name: Tab 2
    label: Tab 2
  - name: Tab 3
    label: Tab 3
  elements:
  - name: order_count
    type: single_value
    model: ecommerce
    explore: orders
    measures: [orders.count]
    tab_name: Tab 1

Conseil : 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, envisagez de réduire la complexité des requêtes des éléments du tableau de bord ou de créer plusieurs tableaux de bord avec moins d'éléments.

group

Remarque : Cette fonctionnalité est disponible en version preview.

Organise les éléments d'un tableau de bord dans un groupe de tuiles sur un tableau de bord LookML. Pour utiliser des groupes de tuiles sur un tableau de bord LookML, votre administrateur Looker doit activer la fonctionnalité en preview "Groupes de tuiles de tableau de bord", et le tableau de bord doit utiliser la méthode de mise en page de tableau de bord newspaper.

Pour créer un groupe de tuiles et y ajouter des éléments en LookML, procédez comme suit :

1. Définissez un conteneur de groupe de tuiles dans la section elements avec type: group, puis spécifiez ses éléments name, title, row, col, width et height (et, éventuellement, tab_name, title_hidden et aria_description). Les éléments de type: group sont des conteneurs visuels et n'acceptent pas les paramètres de requête tels que model, explore ou listen.
2. Sur chaque élément de tableau de bord que vous souhaitez placer dans le groupe de tuiles, ajoutez le paramètre group et définissez sa valeur sur le name de l'élément type: group.

Lorsque vous organisez des éléments dans un groupe de tuiles, tenez compte des points suivants :

• Pour les éléments placés dans un groupe de tuiles, les paramètres row et col définissent la position de l'élément par rapport à l'angle supérieur gauche (row: 0, col: 0) du conteneur du groupe plutôt que du canevas du tableau de bord.
• Sur les tableaux de bord à onglets, l'élément tab_name d'un élément enfant doit correspondre à l'élément tab_name du groupe parent.
• Looker n'accepte pas les groupes de tuiles imbriqués (placer un élément type: group dans un autre groupe de tuiles).

- dashboard: sales_overview
  layout: newspaper
  elements:
  - name: revenue_metrics_group
    title: "Revenue Metrics"
    type: group
    row: 0
    col: 0
    width: 24
    height: 8
  - name: total_revenue
    title: "Total Revenue"
    type: single_value
    model: ecommerce
    explore: orders
    measures: [orders.total_revenue]
    group: revenue_metrics_group
    row: 0
    col: 0
    width: 8
    height: 6