description (pour les explorations)

Cette page fait référence au paramètre description qui fait partie d'une exploration.

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

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

Utilisation

explorer: explore_name {
description: "Description Je veux"
}
Hiérarchie
description
Valeur par défaut
Aucun

Acceptation
Chaîne

Définition

description vous permet d'ajouter des informations concernant la fonctionnalité Explorer à l'interface utilisateur. Ainsi, les utilisateurs peuvent obtenir des informations supplémentaires lors de la création de rapports. Par exemple, voici un paramètre description:

explore: order_items {
  description: "Based on the individual items that comprise customer orders"
}

Si un description est ajouté à une exploration, les utilisateurs peuvent afficher la description en passant la souris sur l'icône d'informations à côté du nom de l'exploration en haut du sélecteur de champ:

Les utilisateurs peuvent également utiliser la même icône d'information dans la liste déroulante des explorations:

Si vous n'ajoutez pas explicitement de description à une exploration, aucune description ne s'affiche.

Examples

Ajoutez une description à une exploration nommée User :

explore: user {
  description: "All customer users, staff users are excluded"
}