Paramètres de graphique à enregistrement unique pour les tableaux de bord LookML

En cours de construction : nous nous efforçons d'ajouter des informations à cette page. En attendant, consultez la page de documentation Options de graphique à enregistrement unique pour savoir comment créer et modifier des visualisations à valeur unique à l'aide du menu d'options de visualisation.

Les paramètres décrits sur cette page sont destinés à être utilisés avec les éléments de tableau de bord LookML de type: looker_single_record dans un dashboard.lkml fichier.

Pour savoir comment créer un graphique à enregistrement unique via l'interface utilisateur Looker, consultez la page de documentation Options de graphique à enregistrement unique.

Paramètres de base

Lorsque vous définissez un élément de tableau de bord LookML, vous devez spécifier des valeurs pour au moins les paramètres name et type. D'autres paramètres de base tels que title, height et width affectent la position et l'apparence d'un élément dans un tableau de bord.

name

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

name peut également être utilisé dans un filtre de tableau de bord, comme décrit sur la page de documentation Paramètres 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 elements paramètre lorsque vous utilisez des layout: grid tableaux de bord.

- name: orders_by_date

title

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

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

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

Le paramètre title vous permet de modifier la façon dont le nom d'un élément s'affiche pour les utilisateurs. Si aucune valeur n'est spécifiée, le titre est défini par défaut sur l'élément name.

Considérez l'exemple suivant :

- name: sales_overview
  title: '1) Sales Overview'

Si vous utilisiez ce format, au lieu de s'afficher sous la forme Aperçu des ventes, l'élément s'afficherait sous la forme 1) Aperçu des ventes.

type

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

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

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

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

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

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

- name: element_name
  type: text | looker_grid | table | single_value | looker_single_record |
        looker_column | looker_bar | looker_scatter | looker_line | looker_area |
        looker_pie | looker_donut_multiples | looker_funnel | looker_timeline |
        looker_map | looker_google_map | looker_geo_coordinates | looker_geo_choropleth | looker_waterfall | looker_wordcloud | looker_boxplot

Consultez la page de documentation type (pour les tableaux de bord LookML) pour obtenir une vue d'ensemble des différents types d'éléments de tableau de bord LookML.

height

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

height peut également être utilisé dans une ligne de tableau de bord, comme décrit sur la page de documentation Paramètres 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 (définie 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 ligne, pour les tableaux de bord layout: newspaper.

Par défaut, un tableau de bord avec une mise en page de type journal a 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 preferred viewer paramètre 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 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 width paramètre qui fait partie d'un élément de tableau de bord.

width peut également être utilisé dans un tableau de bord, comme décrit sur la page de documentation Paramètres 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 a une largeur de 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, ce qui positionne 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é.

Un tableau de bord commence par la ligne 0 en haut du tableau de bord. Par défaut, un tableau de bord avec une mise en page de type journal a une hauteur d'élément de six lignes, ce qui signifie que les éléments de tableau de bord en haut d'un tableau de bord (row: 0) occuperaient par défaut les lignes 0 à 5.

Chaque ligne mesure 50 pixels de haut, ce qui signifie que la hauteur d'élément par défaut de six lignes est de 300 pixels.

Par exemple, le code suivant définit un élément sur la deuxième ligne d'éléments du tableau de bord, en supposant que les éléments sont définis sur la hauteur par défaut :

- dashboard: sales_overview
  layout: newspaper
  ...

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

col

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é.

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

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

- dashboard: sales_overview
  layout: newspaper
  ...

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

refresh

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

refresh peut é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 refresh permet à un élément de se recharger automatiquement à intervalles réguliers, ce qui permet de récupérer des données actualisé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é-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 :

- name: orders_by_date
  refresh: 2 hours

Soyez prudent lorsque vous définissez des intervalles d'actualisation courts. Si la requête derrière l'élément consomme beaucoup de ressources, certains éléments peuvent solliciter votre base de données plus que souhaité.

note

Vous pouvez ajouter des notes descriptives aux éléments comme suit :

- name: element_name
  note:
    text: 'note text'
    state: collapsed | expanded
    display: above | below | hover

note comporte les sous-paramètres text, state et display.

text

Le sous-paramètre text spécifie le texte affiché dans la note. Le texte peut être localisé.

state

Le sous-paramètre state détermine si la note sera collapsed ou expanded si elle est trop grande pour tenir sur une seule ligne dans la largeur de l'élément. Si vous choisissez collapsed et que la note est trop longue, elle se terminera par des points de suspension cliquables (...) qui pourront être utilisés pour lire la note complète.

display

Le sous-paramètre display détermine l'emplacement d'affichage de la note sur un élément. above place la note en haut d'un élément, below la place en bas d'un élément et hover nécessite que l'utilisateur passe la souris sur l'élément pour voir la note.

Paramètres de requête

Lorsque vous définissez un élément de tableau de bord LookML, vous devez spécifier des valeurs pour au moins les paramètres de requête model et explore, et au moins un champ doit être spécifié à l'aide du paramètre dimensions ou du paramètre measures. Vous pouvez également utiliser les autres paramètres de requête pour contrôler la façon dont les données sont affichées dans un élément de tableau de bord.

model

Le paramètre model définit le modèle à utiliser pour la requête d'élément. Si aucune valeur n'est spécifiée, le modèle dans lequel réside le tableau de bord est utilisé par défaut.

- name: orders_by_date
  model: ecommerce

Le paramètre model accepte les constantes LookML. Vous pouvez définir une constante dans le fichier manifeste de votre projet, puis utiliser la syntaxe "@{constant_name}" pour définir la constante comme valeur de model. L'utilisation d'une constante vous permet de définir le nom d'un modèle à un seul endroit, ce qui est particulièrement utile si vous mettez à jour le nom d'un modèle utilisé par plusieurs éléments de tableau de bord.

Pour en savoir plus et obtenir un exemple d'utilisation de constantes avec des tableaux de bord LookML, consultez la page de documentation du paramètre constant.

explore

Cette section fait référence au explore paramètre qui fait partie d'un élément 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 filtre de tableau de bord, comme décrit sur la page de documentation Paramètres de tableau de bord.

Le paramètre explore définit l'exploration à utiliser pour la requête d'élément.

- name: orders_by_date
  explore: order

Le paramètre explore accepte les constantes LookML. Vous pouvez définir une constante dans le fichier manifeste de votre projet, puis utiliser la syntaxe "@{constant_name}" pour définir la constante comme valeur de explore. L'utilisation d'une constante vous permet de définir le nom d'une exploration à un seul endroit, ce qui est particulièrement utile si vous mettez à jour le nom d'une exploration utilisée par plusieurs éléments de tableau de bord.

Pour en savoir plus et obtenir un exemple d'utilisation de constantes avec des tableaux de bord LookML, consultez la page de documentation du paramètre constant.

dimensions

Le paramètre dimensions définit la ou les dimensions à utiliser pour la requête d'élément. Utilisez la syntaxe view_name.dimension_name pour spécifier la dimension. N'incluez pas dimensions si la requête n'en comporte aucune.

## single dimension example
- name: orders_by_date
  dimensions: order.order_date

## multiple dimension example
- name: orders_by_date
  dimensions: [order.order_date, customer.name]

measures

Le paramètre measures définit la ou les mesures à utiliser pour la requête d'élément. Utilisez la syntaxe view_name.measure_name pour spécifier la mesure. N'incluez pas measures si la requête n'en comporte aucune.

## single measure example
- name: orders_by_date
  measures: order.count

## multiple measure example
- name: orders_by_date
  measures: [order.count, order_item.count]

sorts

Le paramètre sorts définit le comportement de tri pour la requête de l'élément. Répertoriez d'abord le champ de tri principal, suivi de tous les champs de tri secondaires. Utilisez la syntaxe view_name.field_name pour spécifier la dimension ou la mesure à trier.

Si vous omettez le paramètre sorts, l'élément utilise l'ordre de tri par défaut de Looker. Les tris ascendants ne nécessitent pas de suffixe, tandis que les tris descendants nécessitent le suffixe desc.

L'exemple suivant définit un seul tri :

- name: orders_by_date
  sorts: order.order_date desc

L'exemple suivant définit plusieurs tris :

- name: orders_by_date
  sorts: [order.order_date desc, customer.name]

Si vous pivotez des dimensions, vous pouvez trier les résultats de la requête en spécifiant le nom de la mesure, le sens du tri et le numéro d'index de base 0 de la colonne cible dans la table de données. Par exemple, l'élément suivant trie la première colonne de pivot à l'aide de l'index 0 :

- name: orders_by_category
  sorts: [orders.count desc 0]

Pour trier par total de ligne, spécifiez l'index de la colonne des totaux. Par exemple, l'élément suivant trie par total de ligne à l'aide de l'index 2, qui représente la colonne des totaux pour une requête avec deux colonnes de pivot :

- name: orders_by_cohort
  sorts: [users.count desc 2]

limit

Le paramètre limit définit la limite de lignes à utiliser pour la requête d'élément. La limite s'applique au nombre de lignes avant l'application des pivots.

- name: orders_by_date
  limit: 100

filters

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

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

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

Le paramètre filters définit les filtres non modifiables à utiliser pour la requête de l'élément. Si vous souhaitez que les filtres qu'un utilisateur peut modifier dans le tableau de bord, vous devez les configurer à l'aide de filters pour les tableaux de bord, puis les appliquer aux éléments à l'aide de listen.

La syntaxe de filters est la suivante :

- name: element_name
  filters:
    orders.created_date: 2020/01/10 for 3 days
    orders.status: Shipped
    # You can create multiple filter statements

Chaque filtre peut accepter une expression de filtre Looker ou une constante de valeur. Vous pouvez également utiliser les variables Liquid _localization ou _user_attributes dans l'expression de filtre pour des valeurs de filtre flexibles.

listen

Les filtres de tableau de bord permettent aux lecteurs d'affiner de manière interactive les données affichées dans les éléments de tableau de bord. Définissez les filtres de tableau de bord avec le filters paramètre pour les tableaux de bord LookML. Ensuite, utilisez le paramètre listen pour lier les éléments de tableau de bord au filtre de tableau de bord.

La syntaxe de listen est la suivante :

- name: element_name
  listen:
    filter_name_goes_here: dimension or measure on which to apply
                           the filter using view_name.field_name syntax
    # You can add more than one listen statement

Ajoutez le paramètre listen à un élément, puis indiquez le nom du filtre suivi d'un signe deux-points et d'une référence au champ auquel le filtre doit s'appliquer, à l'aide de la syntaxe view_name.field_name. Par exemple, vous pouvez créer un filtre appelé Date qui oblige un utilisateur à saisir une date dans le champ de filtre de l'interface utilisateur. Vous pouvez ensuite appliquer la valeur saisie par l'utilisateur à l'élément orders_by_date comme suit :

- dashboard: sales_overview
  ...

  filters:
  - name: date
    type: date_filter

  elements:
 - name: orders_by_date
    listen:
      date: order.order_date
    ...

Pour obtenir d'autres exemples d'utilisation du paramètre filters et du paramètre listen afin d'appliquer des filtres de tableau de bord à des éléments de tableau de bord individuels, consultez Créer des tableaux de bord LookML.

query_timezone

Le paramètre query_timezone spécifie le fuseau horaire dans lequel la requête sera exécutée. Les options de fuseau horaire sont présentées sur la page de documentation timezoneValeurs pour. Si vous souhaitez que la requête s'exécute à l'aide du fuseau horaire du lecteur, vous pouvez attribuer la valeur user_timezone.

- name: orders_by_date
  query_timezone: America/Los Angeles

- name: orders_by_customer
  query_timezone: user_timezone

merged_queries

Le paramètre merged_queries vous permet de combiner les résultats de plusieurs requêtes dans un seul élément du tableau de bord. Définissez chaque requête source dans le paramètre merged_queries de l'élément et utilisez le sous-paramètre join_fields pour spécifier comment les résultats doivent être fusionnés.

L'exemple de code LookML suivant crée un élément de résultats fusionnés de type: looker_grid. Dans cet exemple, le paramètre merged_queries est utilisé pour créer un élément de tableau de bord qui combine les données de deux requêtes distinctes dans un seul graphique de table :

- name: merged_results_element
  title: Merged Results Tile
  type: looker_grid
  merged_queries:
  - model: ecommerce
    explore: users
    type: table
    fields: [users.state, users.count, users.city]
    sorts: [users.count desc 0]
    limit: 5000
    column_limit: 50
    query_timezone: UTC
    listen:
    - State: users.state
  - model: ecommerce
    explore: users
    type: table
    fields: [users.state, users.city]
    sorts: [users.state]
    limit: 500
    column_limit: 50
    query_timezone: UTC
    join_fields:
    - field_name: users.state
      source_field_name: users.state
    - field_name: users.city
      source_field_name: users.city
    listen:
    - State: users.state

Dans cet exemple, l'élément de tableau de bord combine les données de deux requêtes sources basées sur l'exploration users dans le modèle ecommerce. La requête principale inclut les champs users.state, users.count et users.city, et trie les résultats par le champ users.count. La deuxième requête source inclut les champs users.state et users.city, et trie les résultats par le champ users.state.

Le paramètre join_field fusionne les requêtes sources en fonction des valeurs correspondantes dans les champs users.state et users.city.

Le paramètre listen applique un filtre State aux deux requêtes, ce qui permet aux lecteurs du tableau de bord d'affiner les résultats de la requête affichés dans la vignette du tableau de bord en sélectionnant un état spécifique.

Exemple : Fusionner des données d'entreprise

Supposons que vous souhaitiez créer une requête fusionnée qui combine des informations sur les entreprises à partir de deux explorations différentes : company_info et companies. Vous souhaitez joindre les requêtes sur les champs ipo.stock_symbol, companies.name et companies.contact_email de chaque exploration pour créer une requête qui renvoie les résultats pour le nom de l'entreprise, l'adresse e-mail de contact de l'entreprise, l'année d'introduction en bourse, le symbole boursier, le nombre d'employés et le nombre de postes. Vous pouvez définir l'élément de requête fusionnée dans LookML comme suit :

- name: merged_results_element
  title: Merged Results Tile
  merged_queries:
  - model: market_research
    explore: company_info
    fields: [companies.name, companies.contact_email, ipo.public_year, ipo.stock_symbol]
    filters:
      companies.contact_email: "-NULL"
      ipo.valuation_amount: NOT NULL
    sorts: [ipo.public_year desc]
  - model: company_data
    explore: companies
    fields: [companies.name, ipo.stock_symbol, companies.contact_email,
      companies.number_of_employees, jobs.job_count]
    filters:
      companies.number_of_employees: NOT NULL
      ipo.stock_symbol: "-NULL"
      companies.contact_email: "-NULL"
    sorts: [jobs.job_count desc]
    join_fields:
    - field_name: ipo.stock_symbol
      source_field_name: ipo.stock_symbol
    - field_name: companies.name
      source_field_name: companies.name
    - field_name: companies.contact_email
      source_field_name: companies.contact_email

Appliquer des filtres aux éléments de requête fusionnée

Le précédent exemple d'un élément de requête fusionnée montre comment appliquer des filtres codés en dur directement dans chaque requête source à l'aide du paramètre filters. Par exemple, les filtres companies.contact_email: "-NULL" et ipo.valuation_amount: NOT NULL dans la requête principale limitent les résultats aux entreprises qui disposent d'adresses e-mail de contact et d'évaluations valides. Ces filtres au niveau de la requête pré-filtrent les données avant de fusionner les requêtes et ne peuvent pas être modifiés par l'utilisateur.

Vous pouvez également appliquer des filtres de tableau de bord aux éléments de requête fusionnée à l'aide du paramètre listen dans la définition de chaque requête source. Par exemple, supposons que vous ayez un filtre de tableau de bord nommé Industry que vous avez défini au niveau du tableau de bord à l'aide du paramètre filters pour les tableaux de bord LookML :

filters:
- name: Industry
  title: Industry
  type: field_filter
  ui_config:
    type: dropdown_menu
    display: inline
  model: market_research
  explore: company_info
  field: companies.industry

Pour appliquer le filtre Industry au champ companies.industry dans les deux requêtes sources, ajoutez le paramètre listen à chacune des définitions de requête source de la requête fusionnée comme suit :

listen:
  Industry: companies.industry

Par exemple, l'exemple de code suivant ajoute le filtre Industry aux deux requêtes sources dans l'élément de résultats fusionnés de l'exemple précédent.

- name: merged_results_element
  title: Merged Results Tile
  merged_queries:
  - model: market_research
    explore: company_info
    fields: [companies.name, companies.contact_email, ipo.public_year, ipo.stock_symbol]
    filters:
      companies.contact_email: "-NULL"
      ipo.valuation_amount: NOT NULL
    sorts: [ipo.public_year desc]
    listen:
      Industry: companies.industry
  - model: company_data
    explore: companies
    fields: [companies.name, ipo.stock_symbol, companies.contact_email,
      companies.number_of_employees, jobs.job_count]
    filters:
      companies.number_of_employees: NOT NULL
      ipo.stock_symbol: "-NULL"
      companies.contact_email: "-NULL"
    sorts: [jobs.job_count desc]
    join_fields:
    - field_name: ipo.stock_symbol
      source_field_name: ipo.stock_symbol
    - field_name: companies.name
      source_field_name: companies.name
    - field_name: companies.contact_email
      source_field_name: companies.contact_email
    listen:
      Industry: companies.industry

Avec cet ajout, lorsqu'un utilisateur interagit avec le filtre de tableau de bord Industry, la requête source correspondante dans l'élément de requête fusionnée est filtrée en conséquence.

hidden_fields

Le paramètre hidden_fields indique les champs, le cas échéant, qui sont utilisés dans la requête, mais masqués dans le graphique. Tous les champs masqués s'affichent dans la section de table de données d'une exploration.

hidden_fields: [inventory_items.count, distribution_centers.id]

Paramètres d'enregistrement unique

Cette section décrit les équivalents LookML des options du Modifier menu pour les graphiques à enregistrement unique.

show_view_names

Le paramètre show_view_names détermine si les noms de vues sont affichés dans les libellés de graphique, tels que les noms d'axes et les noms de colonnes.

show_view_names: true | false

## default value: true