说明（适用于探索）

本页介绍的是属于探索的 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，则不会显示任何说明。

示例

向名为 User 的探索添加说明：

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