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

ダッシュボードは次のいずれかの方法で作成できます。ユーザー定義のダッシュボードは Looker UI を使用して作成され、ユーザー定義のダッシュボードの作成に関するドキュメント ページで説明されています。ダッシュボードは LookML を使用して作成することもでき、このページで説明するように全体的な設定を変更することもできます。

このページでは、ダッシュボード全体に影響する LookML ダッシュボード パラメータについて説明します。

LookML ダッシュボードには、ダッシュボード上のデータの可視化、テキストタイル、ボタンである要素も含まれています。各要素タイプのリファレンス ページへのリンクについては、ダッシュボードの要素パラメータ ページをご覧ください。

使用例

- dashboard: dashboard_name
  preferred_viewer: dashboards | dashboards-next
  title: "chosen dashboard title"
  description: "chosen dashboard description"
  enable_viz_full_screen: true | false
  extends: name_of_dashboard_being_extended
  extension: required
  layout: tile | static | grid | newspaper
  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 | string_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
    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

パラメータの定義

パラメータ名 説明
dashboard ダッシュボードを作成します。
preferred_viewer このパラメータは無視されます。
title（ダッシュボード用） ユーザーに表示されるダッシュボード名の表示方法を変更します。
description（ダッシュボード用） ダッシュボードの詳細パネルまたはリスト表示に設定されたフォルダで表示できる説明を追加します。
enable_viz_full_screen ダッシュボードの閲覧者がダッシュボード タイルを全画面表示と拡張表示で表示できるかどうかを定義します。
extends LookML ダッシュボードを別の LookML ダッシュボードに基づいて作成します。
extension ダッシュボードが別のダッシュボードによって拡張されることを必須とします。
layout ダッシュボードで要素を配置する方法を定義します。
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 追加 21.16 ダッシュボードのダッシュボード フィルタバーをデフォルトで折りたたむか展開するかを設定します。
filters_location_top 追加 22.8 ダッシュボードのダッシュボード フィルタバーの位置を上または右に設定します。
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 のダッシュボード フィルタの候補を絞り込みます。
埋め込みダッシュボードのパラメータ
embed_style 埋め込みダッシュボードのカスタマイズを定義するために、LookML セクションを開始します。
background_color 埋め込みダッシュボードの背景色を設定します。
show_title 埋め込みダッシュボードにダッシュボードのタイトルを表示するかどうかを指定します。
title_color 埋め込みダッシュボードのタイトルの色を設定します。
show_filters_bar 埋め込みダッシュボードでフィルタバーを表示するかどうかを指定します。
tile_background_color 埋め込みダッシュボードのタイルの背景色を設定します。
tile_text_color 埋め込みダッシュボードのタイルのテキストの色を設定します。
要素パラメータ
elements（ダッシュボード用） ダッシュボード要素を定義するために、LookML セクションを開始します。

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 パラメータについて説明します。

title は、このページの title（フィルタ用）セクションで説明されているように、ダッシュボード フィルタの一部として使用することもできます。

title は、ダッシュボード要素の一部としても使用できます。使用例については、縦棒グラフの要素のドキュメント ページをご覧ください。

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

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

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

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

description （ダッシュボード用）

このセクションでは、ダッシュボードの一部である description パラメータについて説明します。

description は、description（Explore 用）パラメータのドキュメント ページで説明されているように、Explore の一部としても使用できます。

description は、description（フィールド用）パラメータのドキュメント ページで説明されているように、フィールドの一部としても使用できます。

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

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

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

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

enable_viz_full_screen

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

enable_viz_full_screen パラメータを使用すると、ダッシュボードの閲覧者がダッシュボード タイルを全画面表示と拡張表示で表示できるかどうかを設定できます。これは、ダッシュボードの [ビジュアリゼーションの全画面モードを許可する] 設定と同じです。

このパラメータには、true（全画面表示と拡張表示が可能）と false（全画面表示と拡張表示が不可能）の値を指定できます。デフォルト値は true です。

extends

拡張機能によるコードの再利用のドキュメント ページで説明されているように、extends パラメータを使用すると、1 つの LookML ダッシュボードを別の LookML ダッシュボードに基づいて作成し、一部の設定を追加またはオーバーライドできます。extends パラメータは、別の LookML ダッシュボードの名前を受け取ります。

オブジェクトを拡張する場合は、拡張にもローカライズ ルールが適用されることに注意してください。オブジェクトを拡張して新しいラベルや説明を定義する場合は、プロジェクトのロケール文字列ファイルにローカライズ定義を指定する必要があります。詳細については、LookML モデルのローカライズのドキュメント ページをご覧ください。

extension

拡張機能でのコードの再利用のドキュメント ページで説明されているように、extension パラメータは、ダッシュボードが別のダッシュボードによって拡張されることを必須とします。このダッシュボードは他のユーザーには表示されませんが、他のユーザーに表示される他のダッシュボードを作成するためのテンプレートとして使用できます。extension パラメータは値 required のみを受け入れます。extension パラメータが含まれていない場合、ダッシュボードに拡張機能は必要ありません。

layout

layout パラメータは、ダッシュボード要素を配置するときに Looker が使用するレイアウト方法を設定します。次の値を受け入れます。

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 つの要素を 1 行に配置すると、それぞれが使用可能なスペースの 50% を占有します。4 つの要素を 1 つの行に配置すると、それぞれが利用可能なスペースの 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

このセクションでは、ダッシュボードの一部である width パラメータについて説明します。

width は、ダッシュボード要素の一部としても使用できます。使用例については、縦棒グラフの要素のドキュメント ページをご覧ください。

layout: static ダッシュボードの場合、width パラメータは、使用する予定のダッシュボードの合計幅をピクセル単位で定義します。width パラメータは、要素が大きすぎる場合や、要素が多すぎる場合でも、ダッシュボードのサイズを制限しません。width 設定は、ダッシュボードを画面の中央に配置するのに役立ちます。幅を設定しない場合、デフォルトは 1200 です。

- dashboard: sales_overview
  layout: static
  width: 800

refresh

このセクションでは、ダッシュボードの一部である refresh パラメータについて説明します。

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 パラメータについて説明します。

filters は、ダッシュボード要素の一部としても使用できます。使用例については、縦棒グラフの要素のドキュメント ページをご覧ください。

filters は、filters パラメータのドキュメント ページで説明されているように、メジャーの一部としても使用できます。

filters パラメータは、ダッシュボード フィルタを定義する LookML のセクションを開始します。フィルタはダッシュボードの上部に表示され、ユーザーはダッシュボード要素の基になるデータを変更できます。

フィルタが要素に影響を与えるには、listen パラメータを使用して、そのフィルタを「リッスン」するように要素を設定する必要があります。このパラメータは、type: text と type: button 以外のすべての要素タイプに適用されます。listen の動作の典型的な例については、LookML ダッシュボードの縦棒グラフ パラメータのドキュメント ページをご覧ください。

このようにフィルタを要素に適用する場合は、フィルタをリッスンしているディメンションまたはメジャーのタイプとフィルタのタイプが一致していることが重要です（詳しくは、LookML ダッシュボードの作成をご覧ください）。フィルタの形式は次のとおりです。

filters:
- name: filter_name
  title: "chosen filter title"
  type: field_filter | number_filter | date_filter | string_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
  listens_to_filters:
  - filter_name
    field: view_name.field_name

name

このセクションでは、ダッシュボード フィルタの一部である name パラメータについて説明します。

name は、ダッシュボード要素の一部としても使用できます。使用例については、縦棒グラフの要素のドキュメント ページをご覧ください。

各 name 宣言は、新しいダッシュボード フィルタを作成し、それに名前を割り当てます。この名前は、フィルタの影響を受ける要素の listen パラメータで参照されます。listen パラメータは、type: text 以外のすべての要素タイプに適用され、その使用に関する詳細は、個々の可視化タイプのドキュメント ページに表示されます。listen の動作の典型的な例については、LookML ダッシュボードの縦棒グラフ パラメータのドキュメント ページをご覧ください。

filters:
- name: order_date

title （フィルタの場合）

このセクションでは、ダッシュボード フィルタの一部である title パラメータについて説明します。

title は、このページの title（ダッシュボード用）セクションで説明されているように、ダッシュボードの一部としても使用できます。

title は、ダッシュボード要素の一部としても使用できます。使用例については、LookML ダッシュボードの縦棒グラフ パラメータのドキュメント ページをご覧ください。

title パラメータを使用すると、ダッシュボードの上部に表示されるフィルタ名を変更できます。指定しない場合、タイトルにはデフォルトでフィルタの名前が適用されます。

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

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

この場合、フィルタは [注文日] ではなく [注文日] と表示されます。

type

このセクションでは、ダッシュボード フィルタの一部である type パラメータについて説明します。

type は、type（LookML ダッシュボードの場合）パラメータのドキュメント ページで説明されているように、ダッシュボード要素の一部としても使用できます。

type は、type パラメータのドキュメント ページで説明されているように、結合の一部としても使用できます。

type は、ディメンション、フィルタ、パラメータ タイプのドキュメント ページで説明されているように、ディメンションの一部としても使用できます。

type は、メジャーの型のドキュメント ページで説明されているように、メジャーの一部としても使用できます。

type パラメータは、フィルタに配置される入力のタイプを指定します。type: string_filter フィルタにはあらゆるタイプの入力（日付など）を書き込むことができますが、より具体的な情報を指定すると、ユーザーに合わせたフィルタ ウィジェットが提供されます。フィルタには次の 4 種類があります。

  • field_filter: 一般に、基盤となるディメンションまたは指標を指定できる場合は、これがデフォルトの選択肢となります。type: field_filter を使用してフィルタを type:string フィールドに関連付けると、フィルタでフィルタ値の候補が表示されます。
  • number_filter: ユーザーが数値/整数値または式を入力できるようにします。
  • date_filter: ユーザーが日付値または式を入力できるようにします。
  • string_filter: ユーザーが自由形式のテキストを入力できるようにします。

field_filter

選択肢を提示し、指定した基盤となるフィールドに基づいてユーザーへの表示を変更します。

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

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

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

number_filter

候補を表示せず、ユーザーが整数/数値または式を入力できるようにします。

filters:
- name: order_value
  type: number_filter

date_filter

候補を表示せず、ユーザーが日付の値または式を入力できるようにします。

filters:
- name: order_date
  type: date_filter

string_filter

候補を表示せず、ユーザーが自由形式のテキストを入力できるようにします。

filters:
- name: customer_name
  type: string_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: string_filter
  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 に入力する値に応じて、フィルタ オプションは単一選択または複数選択になります。

type でサポートされている値は、フィルタリングするフィールドに割り当てられている LookML データ 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 パラメータで指定された値ごとに 1 つのボタンが表示されます。 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 はデータベースから最初の値を取得します。

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

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

explore

このセクションでは、ダッシュボード フィルタの一部である explore パラメータについて説明します。

explore は、explore パラメータのドキュメント ページで説明されているように、モデルの一部としても使用できます。

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

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

このセクションでは、dashboard の一部である elements パラメータについて説明します。

elements は、このページの elements（行）セクションで説明されているように、ダッシュボードの行の一部としても使用できます。

elements パラメータは、ダッシュボードを構成する要素を定義する LookML セクションを開始します。ダッシュボード要素の外観を定義できるパラメータは多数あります。詳細については、ダッシュボード要素のパラメータのページをご覧ください。

- dashboard: sales_overview
  layout: tile
  elements:
  - name: order_count
    type: single_value
    model: ecommerce
    explore: orders
    measures: [orders.count]

LookML ダッシュボードに追加する要素の数と複雑さを考慮します。要素が増えるほどブラウザのリソースの必要量が増え、ダッシュボードのレンダリング時間が増加します。同様に、大量のデータをレンダリングする要素は、ダッシュボードのパフォーマンスに影響する可能性があります。レンダリングが問題になる場合は、ダッシュボード要素のクエリの複雑さを軽減するか、要素が少ないダッシュボードを複数作成することを検討してください。