En esta página, se hace referencia al parámetro
description
que forma parte de Explorar.
description
también se puede usar como parte de un campo, que se describe en la página de documentación del parámetrodescription
(para campos).
description
también se puede usar como parte de un panel, que se describe en la página de documentación Parámetros del panel.
Uso
description: "Descripción que quiero"
}
Jerarquía
description |
Valor predeterminado
NingunaAcepta
Una string |
Definición
description
le permite agregar información sobre Explorar a la IU, de modo que los usuarios puedan obtener información adicional mientras crean informes. Por ejemplo, este es un parámetro description
:
explore: order_items {
description: "Based on the individual items that comprise customer orders"
}
Si se agrega un elemento description
a un elemento Explore, los usuarios pueden ver la descripción. Para ello, deben desplazarse sobre el ícono de información junto al nombre de este elemento en la parte superior del selector de campos:
Los usuarios también pueden usar el mismo ícono de información en la lista desplegable Explorar:
Si no agregas explícitamente un description
a una Explorar, no se mostrará ninguna descripción.
Ejemplos
Agrega una descripción a Explorar llamada Usuario:
explore: user {
description: "All customer users, staff users are excluded"
}