description (pour les explorations)

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

description peut également être utilisé dans un champ, comme 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

explore: explore_name {
  description: "Description I Want"
}

Hiérarchie Fichier de modèle explore description

Valeur par défaut Aucun Acceptation Chaîne

Définition

description vous permet d'ajouter des informations sur l'exploration à l'interface utilisateur, afin que les utilisateurs puissent obtenir des informations supplémentaires lors de la création de requêtes d'exploration. Voici un exemple de paramètre description :

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

Si une description est ajoutée à une exploration, les utilisateurs peuvent la voir en passant le curseur sur l'icône d'information à côté du nom de l'exploration en haut du sélecteur de champs.

Les utilisateurs peuvent également afficher une description en passant le curseur sur 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.

Exemples

Ajoutez une description à une exploration nommée User :

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