Beschreibung (für Explores)

Auf dieser Seite wird auf den Parameter description verwiesen, der Teil einer Exploration ist.

description kann auch als Teil eines Felds verwendet werden. Weitere Informationen finden Sie auf der Dokumentationsseite zum Parameter description (für Felder).

description kann auch als Teil eines Dashboards verwendet werden. Weitere Informationen finden Sie auf der Dokumentationsseite Dashboard-Parameter.

Nutzung

explore: explore_name {
  description: "Description I Want"
}
Hierarchie
explore
description
Standardwert
Keine

Akzeptiert
Ein String

Definition

Mit description können Sie der Benutzeroberfläche Informationen zum Explore hinzufügen, damit Nutzer beim Erstellen von Explore-Abfragen zusätzliche Informationen erhalten. Hier ein Beispiel für einen description-Parameter:

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

Wenn einem Explore ein description hinzugefügt wird, können Nutzer die Beschreibung einblenden, indem sie den Mauszeiger auf das Informationssymbol verschieben, das sich oben im Field Picker neben dem Explore-Namen befindet.

Außerdem können die Nutzer eine Beschreibung einblenden, indem sie den Mauszeiger auf dasselbe Informationssymbol in der Drop-down-Liste der Explores verschieben.

Wenn Sie einem Explore nicht ausdrücklich eine description hinzufügen, wird keine Beschreibung angezeigt.

Beispiele

Fügen Sie eine Beschreibung für einen Explore mit dem Namen User hinzu:

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