说明（适用于探索）

此页面涉及 Explore 的一部分 description 参数。

description 还可以用作字段的一部分，如 description（针对字段）参数文档页面中所述。

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

用法

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

层次结构 模型文件 explore description

默认值 无 接受 一个字符串

定义

借助 description，您可以向界面添加有关探索的信息，以便用户在创建探索查询时获取更多信息。例如，以下是一个 description 参数：

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

如果探索中添加了 description，用户可以将鼠标悬停在字段选择器顶部探索名称旁边的信息图标上，以查看说明。

用户还可以将鼠标悬停在“探索”下拉列表中的同一信息图标上，以查看说明。

如果您未明确向探索添加 description，则不会显示任何说明。

示例

为名为“用户”的探索添加说明：

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