LookML ダッシュボード パラメータ

ダッシュボードは、次の 2 つの方法のいずれかで作成できます。ユーザー定義のダッシュボードは 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 layout: grid ダッシュボードの各行に配置する要素を定義するために、LookML セクションを開始します。
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 ユーザーが 1 つのフィルタ値しか選べないようにする。
required ダッシュボードを実行するために、ユーザーにフィルタ値の入力を要求します。
ui_config ユーザーが LookML ダッシュボードを表示するときに使用できるフィルタ コントロールを構成します。サブパラメータ type、display、options があります。
model（フィルタの場合） （省略可）type: field_filter フィルタの基になるフィールドを含むモデルを指定します。
explore（フィルタの場合） type: field_filter フィルタの基になるフィールドを含む Explore を指定します。
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 ファイルに配置することをおすすめしますが、1 つのファイルで複数のダッシュボードを宣言することもできます。

- dashboard: sales_overview

ダッシュボードに何かを表示するには、elements パラメータを使用して少なくとも 1 つの要素を追加する必要があります。

preferred_viewer（非推奨）

Looker 23.6 で以前のダッシュボードが非推奨になる前は、preferred_viewer パラメータを使用して、ダッシュボードを表示およびダウンロードする形式を、Looker のデフォルトのダッシュボード エクスペリエンスまたは以前のダッシュボードとして選択できました。

title （ダッシュボード用）

title パラメータを使用すると、フォルダ内とダッシュボードの上部で、ダッシュボード名をユーザーに表示する方法を変更できます。指定しない場合、タイトルはデフォルトでダッシュボードの名前になります。タイトル テキストはローカライズできます。

次の例を考えてみましょう。

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

この場合、ダッシュボードは [Sales Overview] ではなく [1) Sales Overview] と表示されます。

description （ダッシュボード用）

description パラメータを使用すると、LookML ダッシュボードに説明を追加できます。

description パラメータの内容は、LookML ダッシュボードの [ダッシュボードの詳細] パネルの [説明] フィールドに表示されます。

リスト表示に設定されたフォルダで表示すると、説明はダッシュボードのリストのダッシュボード タイトルの下に表示されます。説明が指定されていない場合、リストにはダッシュボードのタイトルのみが表示されます。

説明テキストはローカライズできます。

enable_viz_full_screen

このパラメータは、Looker 管理者が [全画面表示] 設定を有効にしている場合にのみ有効になります。[全画面表示] 設定はデフォルトで有効になっています。

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 パラメータを使用すると、ある LookML ダッシュボードを別の LookML ダッシュボードに基づいて作成し、設定を追加またはオーバーライドできます。extends パラメータは、別の LookML ダッシュボードの名前を受け入れます。

extension

拡張機能でのコードの再利用のドキュメント ページで説明されているように、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 宣言ごとに、ダッシュボードに新しい行が作成されます。行に配置された要素はすべて同じ幅になります。たとえば、1 行に 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 パラメータは、要素が大きすぎる場合や、1 行に要素が多すぎる場合に、ダッシュボードを特定のサイズに制限しません。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)"

この場合、フィルタは [Order Date] ではなく [Order Date(s)] として表示されます。

type

type パラメータは、フィルタに配置される入力のタイプを指定します。type: field_filter は、フィルタを基になるディメンションまたはメジャーに直接接続し、カスタマイズされたフィルタ ウィジェットをユーザーに提供するため、通常はデフォルトの選択肢となります。フィルタの種類は次のとおりです。

  • field_filter: 基になるディメンションまたはメジャーを指定できる場合は、通常、デフォルトの選択肢にする必要があります。type: field_filter を使用してフィルタを type:string フィールドに関連付けると、フィルタで可能なフィルタ値が提案されます。
  • number_filter: ユーザーが数値、整数値、または式を入力できるようにします。
  • date_filter: ユーザーが日付値または式を入力できるようにします。

  • string_filter（非推奨）: string_filter タイプは、Looker 23.6 で従来のダッシュボード エクスペリエンスが非推奨になったため、サポートされなくなりました（詳細については、リリースノートをご覧ください）。候補のプルダウン リストのない自由形式のテキスト入力フィルタが必要な場合は、field_filter を使用した例をご覧ください。

field_filter

選択可能なオプションを提案し、指定した基になるフィールドに基づいてユーザーへの表示を変更します。

これは、ユーザーがフィルタを操作するときに候補を表示する場合に、おすすめのフィルタタイプです。候補が取得されるディメンションは、explore パラメータと field パラメータを使用して定義されます。フィルタ候補を生成するには、type: string のフィールドである必要があります。

フィールドが派生テーブルから取得されている場合、sql_always_where が Explore で使用されている場合、またはフィールドがメジャーである場合、候補が機能しないことがあります。

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 を使用してコントロール タイプを構成します（UI 構成をご覧ください）。

次の例は、候補なしで自由形式のテキスト入力を使用するフィルタを示しています。

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 の Liquid 変数を使用して、デフォルトのフィルタ値を柔軟に設定することもできます。

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

UI でフィルタを構成する方法については、ユーザー定義ダッシュボード フィルタの追加と編集のドキュメント ページをご覧ください。

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 パラメータで指定された値ごとに 1 つのボタンが表示されます。 STR NUM TIER ZIP Y/N DIST DUR
checkboxes フィルタには、options パラメータで指定された値ごとに 1 つのチェックボックスが表示されます。 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 パラメータで指定された値ごとに 1 つのボタンが表示されます。 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 1 日コントロールは、主に時間枠や時間ベースの型で使用できますが、閲覧者が選択できるのはこのコントロールのタイプのある 1 日のみです。
day_range_picker このフィルタを使用すると、ユーザーは開始日と終了日を選択して、日付の範囲でフィルタできます。 D&T 期間コントロールは主に時間枠や時間ベースの型で使用することができますが、閲覧者が選択できるのはこのコントロールのタイプがある期間のみです。
date_time_range_input このフィルタを使用すると、ユーザーは日付と時刻の範囲でフィルタできます。 D&T 日時範囲コントロールは、ほとんどの時間ベースの型で使用できます。閲覧者は、このコントロールのタイプで日付と時刻の両方のオプションを選択する必要があります。
relative_timeframes このフィルタを使用すると、ユーザーはカスタムの日付範囲でフィルタしたり、[今日]、[過去 7 日間]、[過去 90 日間] などのタイムフレーム プリセットから選択したりできます。 D&T 時間枠コントロールは、主に時間枠と時間ベースの型で使用されますが、閲覧者はこのコントロールのタイプがある時間オプションを選択できません。
その他
advancedフィルタには、1 つ以上のフィルタまたは高度な一致フィルタを適用するためのオプションが表示されます。

高度なコントロールの詳細については、このページの高度なコントロールの使用をご覧ください。		 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 としてのみ表示できます。type に対して無効な display 値をフィルタに指定すると、フィルタは inline または popover のいずれか有効な方として表示されます。詳細については、ユーザー定義のダッシュボード フィルタの追加と編集のドキュメント ページをご覧ください。

UI を使用してダッシュボード フィルタを配置する方法については、ユーザー定義フィルタの追加と編集のドキュメント ページをご覧ください。

options

ui_config のオプションの options サブパラメータを使用すると、ユーザーが LookML ダッシュボードを表示するときに、ダッシュボード フィルタ値を一時的に更新するために選択できる値を指定できます。options の値を指定しない場合、Looker はデータベースから最初の値を pull します。

たとえば、次のように users.city フィールドのフィルタに指定できる値として San Francisco、New York、Tokyo を設定できます。


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 パラメータは、使用するフィールドを含む Explore を指定します。

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

field

type: field_filter のダッシュボード フィルタの場合、フィルタが候補を取得するフィールドを定義する必要があります。field パラメータは、使用するフィールドを指定します。完全なスコープのフィールド名を使用することが重要です。つまり、field_name だけでなく view_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 フィルタに入力した内容に基づいて、フィルタの候補を絞り込むことができます。

次の例では、State フィルタに表示される候補は、Order ID フィルタの値に基づいています。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 ダッシュボードに embed_style の設定を反映させるには、LookML を本番環境にデプロイする必要があります。

色を指定する次の埋め込みダッシュボード属性の場合、色の値は #2ca6cd などの 16 進数文字列、または mediumblue などの CSS 指定のカラー文字列にできます。

埋め込みダッシュボードのカスタマイズは次の形式になります。

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