说明(适用于“探索”)

本页中提及的 description 参数是探索的一部分。

description 也可以用作字段的一部分,如 description(适用于字段)参数文档页面所述。

description 也可以用作信息中心的一部分,如信息中心参数文档页面中所述。

用量

探索:探索名称 {
说明“我想要的说明”
}
层次结构
description
默认值


接受
字符串

定义

description 可让您将探索的相关信息添加到界面,以便用户在创建报告时获取更多信息。例如,以下是 description 参数:

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

description 添加到“探索”后,用户可通过将鼠标悬停在字段选择器顶部“探索”名称旁边的信息图标上来查看说明:

用户也可以在“探索”下拉列表中使用相同的信息图标:

如果您未明确地为探索添加 description,系统将不会显示任何说明。

示例

为名为 User 的探索添加说明:

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