本頁面是指 探索中的
description參數。
description也可做為欄位的一部分,詳情請參閱description(適用於欄位) 參數說明文件頁面。
description也可做為資訊主頁的一部分,詳情請參閱「資訊主頁參數」說明文件頁面。
用量
explore: explore_name {
description: "Description I Want"
}
|
階層
description |
預設值
無
接受
一個字串
|
定義
description 可讓您在 UI 中新增探索的相關資訊,方便使用者在建立探索查詢時取得額外資訊。舉例來說,以下是 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"
}