Descripción (para Explorar)

En esta página, se hace referencia al parámetro description que forma parte de una exploración.

description también se puede usar como parte de un campo, que se describe en la página de documentación del parámetro description (para campos).

description también se puede usar como parte de un panel, que se describe en la página de documentación de los parámetros del panel.

Uso

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

Jerarquía Archivo del modelo explore description

Valor predeterminado Ninguno Acepta Una string.

Definición

description te permite agregar información sobre la exploración a la IU, de modo que los usuarios puedan obtener información adicional mientras crean consultas de exploración. Por ejemplo, aquí hay un parámetro description:

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

Si se agrega una description a una exploración, los usuarios pueden ver la descripción colocando el cursor sobre el ícono de información que se encuentra junto al nombre de la exploración en la parte superior del selector de campos.

Los usuarios también pueden ver una descripción colocando el cursor sobre el mismo ícono de información en la lista desplegable de exploraciones.

Si no agregas explícitamente un description a una exploración, no se mostrará ninguna descripción.

Ejemplos

Agrega una descripción a una exploración llamada User:

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