LookML 資訊主頁參數

建立資訊主頁的方式有兩種。使用者定義資訊主頁是透過 Looker UI 建立,詳情請參閱「建立使用者定義資訊主頁」說明文件頁面。您也可以使用 LookML 建立資訊主頁,並按照本頁說明修改整體設定。

本頁面說明會影響整個資訊主頁的 LookML 資訊主頁參數。

LookML 資訊主頁也包含元素,也就是資訊主頁上的資料圖表、文字方塊、按鈕和圖塊群組。如需各元素類型的參考頁面連結,請參閱「資訊主頁元素參數」頁面。

應用實例

- dashboard: dashboard_name
  title: "chosen dashboard title"
  description: "chosen dashboard description"
  enable_viz_full_screen: true | false
  enabled_dashboard_agents: true | false
  default_dashboard_agent: agent_name
  extends: name_of_dashboard_being_extended
  extension: required
  layout: tile | static | grid | newspaper
  tabs:
  - name: Tab 1
    label: Tab 1
  - name: Tab 2
    label: Tab 2
  - name: Tab 3
    label: Tab 3
  - name: Tab 4
    label: Tab 4
  rows:
    - elements: [element_name, element_name, ...]
      height: N
  tile_size: N
  width: N
  refresh: N (seconds | minutes | hours | days)
  auto_run: true | false

  # DASHBOARD FILTER PARAMETERS
  crossfilter_enabled: true | false
  filters_bar_collapsed: true | false
  filters_location_top: true | false
  filters:
  - name: filter_name
    title: "chosen filter title"
    type: field_filter | number_filter | date_filter
    model: model_name
    explore: explore_name
    field: view_name.field_name
    default_value: Looker filter expression
    allow_multiple_values: true | false
    required: true | false
    vis_filter: true | false
    ui_config:
      type: button_group | checkboxes | range_slider | tag_list | radio_buttons |
            button_toggles | dropdown_menu | slider | day_picker | day_range_picker |
            relative_timeframes | advanced
      display: inline | popover | overflow
      options:
        min: N
        max: N
      - value options
    listens_to_filters:
    - filter_name
      field: view_name.field_name

  # EMBEDDED DASHBOARD PARAMETERS
  embed_style:
    background_color: "css_color"
    show_title: true | false
    title_color: "css_color"
    show_filters_bar: true | false
    tile_background_color: "css_color"
    tile_text_color: "css_color"

  # ELEMENTS PARAMETERS
  elements:
  # One or more element declarations
  tab_name:
  # Optional - for organizing elements onto tabs. Must be declared for each element individually.
  group:
  # Optional - for organizing elements into a tile group. Must be declared for each child element individually.

參數定義

參數名稱 說明
dashboard 建立資訊主頁。
title (用於資訊主頁) 變更資訊主頁名稱向使用者顯示的方式。
description (用於資訊主頁) 新增說明,顯示在資訊主頁詳細資料面板,或設為清單檢視的資料夾。
enable_viz_full_screen 定義資訊主頁檢視者是否能以全螢幕和展開檢視查看資訊主頁圖塊。
enabled_dashboard_agents 定義資訊主頁檢視者是否能使用資訊主頁代理,與 LookML 資訊主頁對話。
default_dashboard_agent 指定預設資訊主頁代理,用於資訊主頁上的對話式查詢。
extends 根據其他 LookML 資訊主頁,建立 LookML 資訊主頁。
extension 指定某一資訊主頁需由另一個資訊主頁擴充。
layout 定義資訊主頁的元素編排方式。
tabs 26.4 版新增功能 新增資訊主頁分頁,用於整理資訊主頁上的元素。必須與 tab_name 參數搭配使用,才能指定元素要顯示在哪個分頁。
rows 啟動某一個 LookML 區塊,定義應放入 layout: grid 資訊主頁中每列的元素。
elements (用於資料列) 定義應放入 layout: grid 資訊主頁資料列的元素。
height (用於資料列) 定義layout: grid資訊主頁的列高。
tile_size 定義 layout: tile 資訊主頁的資訊方塊大小。
width (用於資訊主頁) 定義 layout: static 資訊主頁的寬度。
refresh (用於資訊主頁) 設定資訊主頁元素自動重新整理的間隔時間。
auto_run 決定資訊主頁是否在初次開啟或重新載入時自動執行。
篩選器參數
crossfilter_enabled 啟用或停用資訊主頁的交叉篩選功能。
filters_bar_collapsed 將資訊主頁篩選器列預設為收合或展開。
filters_location_top 將資訊主頁篩選器列的位置設為資訊主頁的頂端或右側。
filters (用於資訊主頁) 啟動某一個 LookML 區塊,定義資訊主頁篩選器。
name (篩選器) 。
title (篩選器) 變更篩選器名稱向使用者顯示的方式。
type (篩選器) 決定要使用的篩選器類型。
default_value 設定篩選器的預設值。
allow_multiple_values 限制使用者只能選取一個篩選器值。
required 使用者必須輸入篩選器值,才能執行資訊主頁。
ui_config 設定使用者查看 LookML 資訊主頁時可用的篩選器控制項。包含子參數 type、display 和 options。
model (篩選器) (選用) 指定包含 type: field_filter 篩選器基礎欄位的模型。
explore (篩選器) 指定包含 type: field_filter 篩選器基礎欄位的探索。
field 指定 type: field_filter 篩選器的基礎欄位。
listens_to_filters 根據使用者在另一個資訊主頁篩選器「type: field_filter」輸入的內容,縮小資訊主頁篩選器「field_filter」的建議範圍。
vis_filter 設定篩選器,直接顯示在圖表圖塊上,而非資訊主頁篩選列中。
嵌入式資訊主頁參數
embed_style 啟動某一個 LookML 區塊,定義嵌入資訊主頁的自訂項目。
background_color 設定嵌入式資訊主頁的背景顏色。
show_title 指定是否要在嵌入的資訊主頁上顯示資訊主頁標題。
title_color 設定內嵌資訊主頁的標題顏色。
show_filters_bar 指定是否在嵌入式資訊主頁上顯示篩選器列。
tile_background_color 設定嵌入式資訊主頁的圖塊背景顏色。
tile_text_color 設定嵌入式資訊主頁的圖塊文字顏色。
元素參數
elements (用於資訊主頁) 啟動某一個 LookML 區塊,定義資訊主頁元素。
group (用於元素) 指定 type: group 元素的名稱,將資訊主頁元素整理成圖塊群組。

dashboard

dashboard 參數會宣告新的資訊主頁,並指定資訊主頁的名稱。長度上限為 255 個字元,允許的字元包括英文字母 (A-Z)、數字 (0-9)、連字號 (-) 和底線 (_)。一般來說,最佳做法是將每個 LookML 資訊主頁放在專屬的 LookML 檔案中,但您也可以在單一檔案中宣告多個資訊主頁。

- dashboard: sales_overview

資訊主頁必須使用 elements 參數新增至少一個元素,才能顯示任何內容。

preferred_viewer (已淘汰)

在 Looker 23.6 淘汰舊版資訊主頁之前,preferred_viewer 參數可讓您選擇查看及下載資訊主頁的格式,包括 Looker 的預設資訊主頁體驗或舊版資訊主頁。

title (資訊主頁)

title 參數可讓您變更資訊主頁名稱在資料夾和資訊主頁頂端的顯示方式。如未指定,標題預設為資訊主頁名稱。標題文字可以本地化。

請參閱以下範例:

- dashboard: sales_overview
  title: "1) Sales Overview"

這樣一來,資訊主頁就不會顯示為「銷售總覽」,而是「1) 銷售總覽」。

description (資訊主頁)

description 參數可讓您為 LookML 資訊主頁新增說明。

description 參數的內容會顯示在 LookML 資訊主頁「資訊主頁詳細資料」面板的「說明」欄位。

在設為清單檢視的資料夾中,說明會顯示在資訊主頁清單的資訊主頁標題下方。如未指定說明,清單只會顯示資訊主頁標題。

說明文字可以本地化。

enable_viz_full_screen

只有在 Looker 管理員啟用「Full Screen Visualizations」(全螢幕圖表) 設定時,這項參數才會生效。「全螢幕視覺化」設定預設為啟用。

enable_viz_full_screen 參數可設定資訊主頁檢視者是否能以全螢幕和展開檢視查看資訊主頁圖塊。這相當於資訊主頁設定「允許以全螢幕模式呈現圖表」。

這項參數可設為 true (可使用全螢幕和展開檢視模式) 和 false (無法使用全螢幕和展開檢視模式)。預設值為 true。

enabled_dashboard_agents

enabled_dashboard_agents 參數可控管資訊主頁檢視者能否使用資訊主頁代理與 LookML 資訊主頁對話。

您必須在 Gemini in Looker 管理頁面,為 Looker 執行個體啟用「資訊主頁代理」設定,這項參數才會生效。

這個參數可接受 true (啟用聊天室) 和 false (停用聊天室)。如果 LookML 資訊主頁檔案省略這個參數,API 層會預設為 true。

- dashboard: sales_overview
  enabled_dashboard_agents: true

default_dashboard_agent

default_dashboard_agent 參數會指定要與 LookML 資訊主頁建立關聯的預設資訊主頁代理名稱。指定的代理程式必須使用 agent LookML 參數宣告。

檢視者與資訊主頁展開對話時,系統會將預設代理的設定 (例如思考模式和偵錯資訊顯示) 套用至對話。

- dashboard: sales_overview
  default_dashboard_agent: sales_overview_agent

如果 enabled_dashboard_agents 為 true,且未指定 default_dashboard_agent,使用者仍可使用預設設定與資訊主頁對話,不需自訂指令。

extends

如「使用 extends 重複使用程式碼」說明文件頁面所述,extends 參數可讓您根據另一個 LookML 資訊主頁建立 LookML 資訊主頁,並視需要新增或覆寫部分設定。extends 參數接受其他 LookML 資訊主頁的名稱。

extension

如「使用 extends 重複使用程式碼」說明文件頁面所述,extension 參數表示資訊主頁「必須」由另一個資訊主頁擴充。其他使用者一律無法查看這個資訊主頁,但您可以使用這個資訊主頁做為範本,建立其他使用者可查看的其他資訊主頁。extension 參數只接受 required 值。如果未加入 extension 參數,資訊主頁就不需要擴充功能。

layout

layout 參數會設定 Looker 在放置資訊主頁元素時使用的版面配置方法。可接受的值如下:

tabs

新增分頁,用於整理資訊主頁上的元素。tabs 定義資訊主頁上顯示的分頁數量、名稱和標籤。元素會使用 tab_name 參數,在資訊主頁分頁中整理。

- dashboard: sales_overview
  layout: tile
  tabs:
  - name: Tab 1
    label: Tab 1
  - name: Tab 2
    label: Tab 2
  - name: Tab 3
    label: Tab 3
  - name: Tab 4
    label: Tab 4

tab_name

指定元素會顯示在資訊主頁的哪個分頁。必須為每個元素指定 tab_name。

- dashboard: sales_overview
  layout: tile
  tabs:
  - name: Tab 1
    label: Tab 1
  - name: Tab 2
    label: Tab 2
  - name: Tab 3
    label: Tab 3
  - name: Tab 4
    label: Tab 4
  elements:
  - name: order_count
    type: single_value
    model: ecommerce
    explore: orders
    measures: [orders.count]
    tab_name: Tab 1

rows

如果是 layout: grid 資訊主頁,rows 參數會啟動 LookML 區段,您可以在其中定義哪些元素應放入哪些資料列,以及每個資料列的高度。在每個資料列中,每個元素的寬度都相同。如果未在這個部分列出元素,該元素就不會顯示在資訊主頁上。

- dashboard: sales_overview
  layout: grid
  rows:
    - elements: [element_name, element_name, ...]
      height: 200
    - elements: [element_name, element_name, ...]
      height: 300

elements

elements 參數會採用資訊主頁元素名稱清單,並以半形逗號分隔。每個 elements 宣告都會在資訊主頁中建立新的一列。放在同一列的元素寬度都相同。因此,如果您在資料列中放置 2 個元素,每個元素會佔用 50% 的可用空間。如果將 4 個元素放入一列,每個元素會各占 25% 的可用空間。

height

height 參數會定義資料列的高度 (以像素為單位)。預設值為 300。

tile_size

在 layout: tile 和 layout: static 資訊主頁中,用來調整元素大小和位置的單位是圖塊大小。tile_size 的單位為像素,預設值為 160。例如:

- dashboard: sales_overview
  layout: tile
  tile_size: 100

在這種情況下,具有 height: 5 和 width: 3 的資訊主頁元素高度為 500 像素,寬度為 300 像素。height 和 width 參數適用於所有元素類型,如要瞭解其用法,請參閱各個圖表類型的說明文件頁面。如需 height 和 width 運作方式的代表性範例,請參閱「LookML 資訊主頁的柱狀圖參數」說明文件頁面。

width

如果是 layout: static 資訊主頁,width 參數會定義您要使用的資訊主頁總寬度 (以像素為單位)。如果您定義的元素過大,或一列中的元素過多,width 參數「不會」將資訊主頁限制在特定大小。而是讓資訊主頁保持在畫面中央。width如未設定寬度,預設值為 1200。

- dashboard: sales_overview
  layout: static
  width: 800

refresh

refresh 參數可讓資訊主頁定期自動重新載入,擷取最新資料。如果資訊主頁會持續顯示 (例如在辦公室電視上),這項功能通常很有幫助。請注意,您必須在瀏覽器視窗中開啟資訊主頁,這個參數才會生效。這項設定不會在背景執行,以「預熱」資訊主頁快取。

重新整理頻率可以是任何數字 (不含小數),單位為秒、分、時或天。例如:

- dashboard: sales_overview
  refresh: 2 hours

設定較短的重新整理間隔時,請務必謹慎。資訊主頁可能包含許多查詢,其中有些可能需要大量資源,因此某些資訊主頁可能會對資料庫造成負擔。

auto_run

auto_run 參數會決定資訊主頁是否在初次開啟或重新載入時執行。預設值為 true。如果將這個參數設為 false,使用者必須按下「執行」按鈕,才能載入資訊主頁。舉例來說,像這樣的資訊主頁會在開啟時自動執行:

- dashboard: sales_overview
  auto_run: true

無論 auto_run 設定為何,使用者變更篩選器值後,一律必須點選「執行」按鈕。這樣一來,當使用者在變更篩選器時暫停,或想同時變更多個篩選器,就不會發生不必要的重新載入。

crossfilter_enabled

crossfilter_enabled 參數可讓您開啟或關閉資訊主頁的交叉篩選器。如果將這個參數設為 true,資訊主頁檢視者只要點選特定資料點,就能在資訊主頁上建立交叉篩選器。

- dashboard: sales_data
  crossfilter_enabled: true

filters_bar_collapsed

filters_bar_collapsed 參數可讓您將資訊主頁篩選器列設為預設收合或展開。如果將這個參數設為 true,篩選列預設會收合。資訊主頁檢視者可以點選「篩選器」圖示展開篩選列。這項設定的預設值為 false。

- dashboard: sales_data
  filters_bar_collapsed: true

filters_location_top

filters_location_top 參數可讓您將資訊主頁篩選器列放在資訊主頁的頂端或右側。如果將這個參數設為 true,篩選器列會顯示在資訊主頁頂端;如果設為 false,篩選器列會顯示在資訊主頁右側。這項設定的預設值為 true。

- dashboard: sales_data
  filters_location_top: false

filters

filters 參數會啟動 LookML 區塊,您可以在其中定義資訊主頁篩選器。篩選器會顯示在資訊主頁頂端,使用者可透過篩選器變更資訊主頁元素背後的資料。

如要讓篩選器影響元素,必須使用 listen 參數,將元素設為「監聽」該篩選器。這項參數適用於所有元素類型,但 type: text、type: button 和 type: group 除外。如需 listen 運作方式的代表性範例,請參閱「LookML 資訊主頁的柱狀圖參數」說明文件頁面。

以這種方式將篩選器套用至元素時,篩選器類型必須與監聽篩選器的維度或測量指標類型相符 (詳情請參閱「建構 LookML 資訊主頁」)。

篩選器的格式如下:

filters:
- name: filter_name
  title: "chosen filter title"
  type: field_filter | number_filter | date_filter
  model: model_name
  explore: explore_name
  field: view_name.field_name
  default_value: Looker filter expression
  allow_multiple_values: true | false
  required: true | false
  vis_filter: true | false
  listens_to_filters:
  - filter_name
    field: view_name.field_name

name

每個 name 宣告都會建立新的資訊主頁篩選器,並為其指派名稱。在應受篩選器影響的元素中,listen 參數會參照這個名稱。listen 參數適用於 type: text、type: button 和 type: group 以外的所有元素類型,其用法詳情請參閱各個圖表類型的說明文件頁面。如需 listen 運作方式的代表性範例,請參閱「LookML 資訊主頁的柱狀圖參數」說明文件頁面。

filters:
- name: order_date

title (篩選器)

title 參數可讓您變更篩選器名稱在資訊主頁頂端向使用者顯示的方式。如未指定,標題預設為篩選器名稱。

請參閱以下範例:

filters:
- name: order_date
  title: "Order Date(s)"

如果這樣做,篩選器就不會顯示為「訂單日期」,而是「訂單日期」。

type

type 參數會指定要放入篩選器的輸入內容類型。type: field_filter 通常是預設選項,因為它會將篩選器直接連結至基礎維度或測量指標,並為使用者提供量身打造的篩選器小工具。篩選器類型如下:

  • field_filter:如果可以指定基礎維度或測量指標,通常應選擇這個選項。使用 type: field_filter 並將篩選器與 type:string 欄位建立關聯,篩選器就會建議可能的篩選值。
  • number_filter:可讓使用者輸入數字、整數值或運算式。
  • date_filter:讓使用者輸入日期值或運算式。

  • string_filter (已淘汰):自 Looker 23.6 版淘汰舊版資訊主頁服務後,系統就不再支援 string_filter 類型 (詳情請參閱版本資訊)。如要使用不含建議下拉式選單的任意形式文字輸入篩選器,請參閱使用 field_filter 的範例。

field_filter

建議可供選擇的選項,並根據您指定的基礎欄位,變更向使用者顯示的方式。

如果想在使用者與篩選器互動時提供建議,建議使用這類篩選器。系統會使用 explore 和 field 參數定義要從哪個維度擷取建議,且該維度必須是 type: string 欄位,才能產生篩選器建議。

如果欄位來自衍生資料表、探索使用 sql_always_where,或欄位是測量指標,建議可能無法運作。

以下是 field_filter 類型的 LookML 範例:

filters:
- name: order_date
  type: field_filter
  explore: orders
  field: orders.order_date  # must be of the form view_name.dimension_name

如要使用不含建議下拉式選單的自由格式文字輸入篩選器,請使用 type: field_filter,然後使用 ui_config: type: advanced 設定控制項類型 (請參閱「使用者介面設定」)。

以下範例顯示使用任意形式文字輸入,且不提供建議的篩選器:

filters:
- name: customer_name
  type: field_filter
  explore: orders
  field: customer.name
  ui_config:
    type: advanced

number_filter

不提供建議,讓使用者輸入整數、數值或運算式。

filters:
- name: order_value
  type: number_filter

date_filter

不提供建議,讓使用者輸入日期值或運算式。

filters:
- name: order_date
  type: date_filter

default_value

default_value 參數可讓您指定篩選器的預設值。這個值可做為合理的起點,對使用者很有幫助。

請務必根據使用的篩選器類型,設定相符的預設值。例如:

filters:
- name: order_value
  type: number_filter
  default_value: "50 to 100"

- name: order_date
  type: date_filter
  default_value: "last 30 days"

- name: customer_name
  type: field_filter
  explore: orders
  field: customer.name
  default_value: "John Doe"

您可以使用篩選運算式建立預設值。詳情請參閱「Looker 篩選運算式」說明文件頁面。

同時使用 default_value 和 ui_config 參數時,篩選運算式必須與 ui_config 的 type 子參數值,以及支援 type 值的資料類型相容。

您也可以使用 _localization 和 _user_attributes 液體變數,彈性設定預設篩選器值。

allow_multiple_values

allow_multiple_values 參數可控管使用者能否選取單一或多個篩選器值。如果這個參數設為 true (預設值),使用者可以為篩選器選取多個值。如果將這個參數設為 false,使用者只能選取一個篩選器值。

例如:

filters:
- name: Order ID
  title: Order ID
  type: field_filter
  allow_multiple_values: true
  required: false
  model: thelookstore
  explore: orders
  field: orders.id

required

required 參數可讓您要求使用者提供篩選器值,才能執行資訊主頁。根據預設,篩選器不需要值。如果篩選器不需要值,且留空,資料就不會受到篩選器欄位限制。如果篩選器需要值,但留空,資訊主頁就不會執行。

filters:
  - name: State
    title: State
    type: field_filter
    required: true

ui_config

filters 的 ui_config 子參數可用來設定 LookML 資訊主頁的篩選器。這些設定包括使用的篩選器控制項類型、篩選器控制項位置,以及可能的篩選器值。

例如:


  filters:
  - name: City
    title: City
    type: field_filter
    default_value: San Francisco
    allow_multiple_values: true
    required: false
    ui_config:
      type: button_group
      display: inline
      options:
      - San Francisco
      - New York
      - Tokyo
    model: thelook
    explore: order_items
    field: users.city

如要進一步瞭解如何透過使用者介面設定篩選器,請參閱「新增及編輯使用者定義資訊主頁篩選器」說明文件頁面。

type

您可以使用 ui_config 的 type 子參數,指定要顯示的篩選器控制項類型。

視您為 type 輸入的值而定,篩選器控制項可以是單選或多選。

STR = 與 string 資料類型相容 DIST = 與 distance 資料類型相容
NUM = 與 number 資料類型和數值測量指標相容 DUR = 與 duration 資料類型相容
TIER = 與 tier 資料類型相容 D&T = 與大多數日期和時間資料類型相容
ZIP = 與 zipcode 資料類型相容 LOC = 與 location 資料類型相容
Y/N = 與 yesno 資料類型相容 PAR = 與 parameter 參數相容
值說明支援的資料類型
選取多個選項
button_group 篩選器會顯示一組按鈕,每個按鈕對應 options 參數指定的值。 STR NUM TIER ZIP Y/N DIST DUR
checkboxes 篩選器會顯示核取方塊,每個核取方塊對應 options 參數指定的每個值。 STR NUM TIER ZIP Y/N DIST DUR
tag_list 篩選器會顯示下拉式選單,列出使用 options 參數指定的每個可能值。 STR NUM TIER ZIP DIST DUR
range_slider 如果是數值欄位,篩選器會顯示滑桿,讓使用者設定一組數字範圍做為篩選器的值。options 的 min 和 max 子參數可用來指定篩選條件的可能最小值和最大值,而預設範圍則可使用 default_value 參數指定。 NUM DIST DUR
單選
button_toggles 篩選器會顯示一組按鈕,每個按鈕對應 options 參數指定的值。 STR NUM TIER ZIP Y/N DIST DUR PAR
radio_buttons 篩選器會顯示圓形按鈕,其中一個按鈕代表「任何值」,其他按鈕則分別代表 options 參數指定的各個值。 STR NUM TIER ZIP Y/N DIST DUR PAR
dropdown_menu 篩選器會顯示下拉式選單,列出使用 options 參數指定的每個可能值。下拉式選單也提供「任何值」選項。 STR NUM TIER ZIP Y/N DIST DUR PAR
slider 如果是數值欄位,篩選器會顯示滑桿,讓使用者在可能的最大值和最小值之間滑動,選擇篩選條件。這些值是使用 options 參數指定。 NUM DIST DUR
日期和時間
day_picker 使用者可以選擇特定日期來篩選資料。 D&T:單日控制項可與大多數時間範圍和時間類型搭配使用,但檢視者只能使用這類控制項選取單一日期。
day_range_picker 使用者可以選取開始日期和結束日期,篩選特定日期範圍。 D&T:日期範圍控制項可與大多數時間範圍和時間類型搭配使用,但檢視者只能選取具有這類控制項的日期範圍。
date_time_range_input 使用者可透過篩選器,篩選特定日期和時間範圍。 D&T:日期和時間範圍控制項可與大多數時間類型搭配使用,且檢視者必須使用這類控制項選取日期和時間選項。
relative_timeframes 使用者可以透過篩選器,篩選自訂日期範圍,或從預設時間範圍中選擇,例如「今天」、「過去 7 天」或「過去 90 天」。 D&T:時間範圍控制項可與大多數時間範圍和時間類型搭配使用,但檢視者無法使用這類控制項選取時間選項。
其他
advanced篩選器會顯示套用一或多個篩選器或進階比對篩選器的選項。

如要進一步瞭解進階控制項,請參閱本頁的「使用進階控制項」一節。
STR NUM TIER ZIP Y/N D&T DIST DUR LOC PAR

display

您可以使用 ui_config 的 display 子參數,設定資訊主頁篩選器的位置。您可以將下列其中一個值指派給 display,藉此設定篩選器的位置:

  • inline:篩選器會直接顯示在資訊主頁的頂端列中。
  • popover:資訊主頁頂端列會顯示摘要值,點選即可查看完整篩選器。
  • overflow:資訊主頁頂端列會顯示「更多」按鈕,並以數字指標顯示溢位篩選器的數量;使用者可以點選按鈕,查看溢位篩選器及其值。

部分篩選器類型只能以特定方式顯示。舉例來說,type: day_picker 的篩選器只能顯示為 inline 或 overflow。如果篩選器的 display 值不適用於該 type,篩選器會顯示 inline 或 popover (以有效者為準)。詳情請參閱「新增及編輯使用者定義資訊主頁篩選器」說明文件頁面。

如要瞭解如何使用使用者介面調整資訊主頁篩選器的位置,請參閱「新增及編輯使用者定義的篩選器」說明文件頁面。

options

ui_config 的選用 options 子參數可讓您指定值,供使用者在查看 LookML 資訊主頁時,暫時更新資訊主頁篩選器值。如未指定 options 的任何值,Looker 會從資料庫提取第一個值。

舉例來說,您可以將 San Francisco、New York 和 Tokyo 設為 users.city 欄位篩選器的可能值,如下所示:


ui_config:
  type: button_group
  display: inline
  options:
  - San Francisco
  - New York
  - Tokyo

如果 ui_config 的 type 子參數設為 range_slider 或 slider,您可以使用 options 的 min 和 max 子參數:

  • min:設定篩選器的可能最小值。
  • max::設定篩選器的可能最大值。

例如:


ui_config:
  type: range_slider
  display: inline
  options:
    min: 0
    max: 500

model

如果是 type: field_filter 的資訊主頁篩選器,model 參數會定義要使用的欄位模型。model 參數為選用,預設為資訊主頁所屬的模型。

filters:
- name: State
  title: State
  type: field_filter
  default_value: California
  model: thelookstore
  explore: users
  field: users.state

explore

如果是 type: field_filter 類型的資訊主頁篩選器,您必須定義篩選器要從哪個欄位擷取建議。explore 參數會指定哪個探索包含您要使用的欄位。

filters:
- name: order_date
  type: field_filter
  explore: orders
  field: orders.order_date

field

如果是 type: field_filter 類型的資訊主頁篩選器,您必須定義篩選器要從哪個欄位擷取建議。field 參數會指定要使用的欄位。請務必使用完整範圍的欄位名稱。換句話說,請使用 view_name.field_name,而非 field_name。

filters:
- name: order_date
  type: field_filter
  explore: orders
  field: orders.order_date

listens_to_filters

如果是 type: field_filter 的資訊主頁篩選器,您可以根據使用者在另一個 type: field_filter 篩選器中輸入的內容,縮小篩選器的建議範圍。

在以下範例中,系統會根據 Order ID 篩選器的值,提供 State 篩選器的建議。無論為 Order ID 篩選器選取哪些值,都會有相關聯的 users.state 值,而這些值會是 State 篩選器的建議值。詳情請參閱「新增及編輯使用者定義資訊主頁篩選器」說明文件頁面。

filters:
- name: State
  title: State
  type: field_filter
  model: thelookstore
  explore: users
  listens_to_filters:
  - Order ID
  field: users.state

vis_filter

vis_filter 參數可讓您將篩選器設為圖表層級篩選器,直接顯示在個別圖表圖塊上,而非頂端的資訊主頁篩選器列。

vis_filter 設為 true 時,篩選器會顯示在任何監聽該篩選器的圖表頂端篩選器列中 (使用資訊主頁元素的 listen 參數設定)。預設值為 false,篩選器會以標準資訊主頁層級篩選器的形式,顯示在頂端篩選器列中。標準資訊主頁篩選器不需要設定 vis_filter: false。

例如:

filters:
- name: order_date
  title: "Order Date"
  type: date_filter
  default_value: "last 30 days"
  vis_filter: true

如要進一步瞭解圖表層級篩選器,請參閱「圖表圖塊篩選器」說明文件頁面。

embed_style

embed_style 參數會啟動 LookML 區塊,您可以在其中自訂嵌入資訊主頁的外觀。embed_style 和相關參數僅支援嵌入式資訊主頁,如果資訊主頁未嵌入,系統會忽略這些參數。

變更 embed_style 後,您必須將 LookML 部署至正式環境,才能在嵌入的 LookML 資訊主頁中看到 embed_style 設定。

下列嵌入式資訊主頁屬性會指定顏色,顏色值可以是十六進位字串 (例如 #2ca6cd),或 CSS 命名顏色字串 (例如 mediumblue)。

嵌入式資訊主頁自訂項目採用下列格式:

embed_style:
  background_color: "css_color"
  show_title: true | false
  title_color: "css_color"
  show_filters_bar: true | false
  tile_background_color: "css_color"
  tile_text_color: "css_color"

background_color

設定嵌入式資訊主頁的背景顏色。

embed_style:
  background_color: "#ffffff"

show_title

指定使用者是否能看到嵌入的資訊主頁標題。

embed_style:
  show_title: false

title_color

設定內嵌資訊主頁的標題顏色。

embed_style:
  title_color: "#008000"

show_filters_bar

指定使用者是否能看到嵌入的資訊主頁篩選器。

embed_style:
  show_filters_bar: true

tile_background_color

設定嵌入式資訊主頁上所有圖塊的背景顏色。

embed_style:
  tile_background_color: "lightyellow"

tile_text_color

設定嵌入式資訊主頁上所有圖塊的文字顏色。

embed_style:
  tile_text_color: "crimson"

elements

elements 參數會啟動 LookML 區塊,您可以在其中定義構成資訊主頁的元素。許多參數都可以定義資訊主頁元素的外觀。如需詳細說明,請參閱「資訊主頁元素參數」頁面。

- dashboard: sales_overview
  layout: tile
  tabs:
  - name: Tab 1
    label: Tab 1
  - name: Tab 2
    label: Tab 2
  - name: Tab 3
    label: Tab 3
  elements:
  - name: order_count
    type: single_value
    model: ecommerce
    explore: orders
    measures: [orders.count]
    tab_name: Tab 1

group

將資訊主頁元素整理成 LookML 資訊主頁上的圖塊群組。如要在 LookML 資訊主頁使用圖塊群組,Looker 管理員必須啟用資訊主頁圖塊群組預先發布版功能,且資訊主頁必須使用 newspaper 資訊主頁版面配置方法。

如要在 LookML 中建立圖塊群組並新增元素,請按照下列步驟操作:

  1. 在 elements 區段中使用 type: group 定義圖塊群組容器,並指定其 name、title、row、col、width 和 height (以及選用的 tab_name、title_hidden 和 aria_description)。type: group 的元素是視覺容器,不接受 model、explore 或 listen 等查詢參數。
  2. 針對要放在圖塊群組中的每個資訊主頁元素,新增 group 參數,並將其值設為 type: group 元素的 name。

將元素整理成圖塊群組時,請注意下列事項:

  • 對於放置在圖塊群組中的元素,row 和 col 參數會定義元素相對於群組容器左上角 (row: 0、col: 0) 的位置,而非資訊主頁畫布。
  • 在分頁式資訊主頁上,子元素的 tab_name 必須與父項群組的 tab_name 相符。
  • Looker 不支援巢狀圖塊群組 (將 type: group 元素放在另一個圖塊群組中)。
- dashboard: sales_overview
  layout: newspaper
  elements:
  - name: revenue_metrics_group
    title: "Revenue Metrics"
    type: group
    row: 0
    col: 0
    width: 24
    height: 8
  - name: total_revenue
    title: "Total Revenue"
    type: single_value
    model: ecommerce
    explore: orders
    measures: [orders.total_revenue]
    group: revenue_metrics_group
    row: 0
    col: 0
    width: 8
    height: 6