description (per le esplorazioni)

Questa pagina si riferisce al parametro description che fa parte di un'esplorazione.

description può essere utilizzato anche nell'ambito di un campo, come descritto nella pagina della documentazione dedicata al parametro description (per i campi).

description può essere utilizzato anche nell'ambito di una dashboard, come descritto nella pagina della documentazione Parametri della dashboard.

Utilizzo

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

Gerarchia File del modello explore description

Valore predefinito Nessuno Accetta Una stringa

Definizione

description ti consente di aggiungere informazioni sull'esplorazione all'interfaccia utente, in modo che gli utenti possano ottenere informazioni aggiuntive durante la creazione di query di esplorazione. Ad esempio, ecco un parametro description:

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

Se viene aggiunto un description a un'esplorazione, gli utenti possono visualizzare la descrizione passando il mouse sopra l'icona delle informazioni accanto al nome dell'esplorazione nella parte superiore del selettore di campi.

Gli utenti possono anche visualizzare una descrizione passando il mouse sopra la stessa icona delle informazioni nell'elenco a discesa di Esplora.

Se non aggiungi esplicitamente un description a un Esplora, non verrà visualizzata alcuna descrizione.

Esempi

Aggiungi una descrizione a un'esplorazione denominata Utente:

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