工事中: このページには今後さらに情報が追加される予定です。それまでの間、タイムライン グラフのオプションのドキュメント ページで、ビジュアリゼーション オプション メニューを使用してタイムライン グラフを作成、編集する方法をご覧ください。
このページで説明するパラメータは、dashboard.lkml ファイルの type: looker_timeline の LookML ダッシュボード要素で使用できます。
Looker UI を使用してタイムライン グラフを作成する方法については、タイムライン グラフのオプションのドキュメント ページをご覧ください。
基本パラメータ
LookML ダッシュボード要素を定義する場合は、少なくとも name と type の基本パラメータの値を指定する必要があります。title、height、width などの他の基本パラメータは、ダッシュボード上の要素の外観と位置に影響します。
name
このセクションでは、ダッシュボード要素の一部である
nameパラメータについて説明します。
nameは、ダッシュボード パラメータのドキュメント ページで説明されているように、ダッシュボード フィルタの一部として使用することもできます。
各 name 宣言は、新しいダッシュボード要素を作成し、名前を割り当てます。要素名は一意である必要があります。layout: grid ダッシュボードを使用している場合、名前は elements パラメータで参照されることがあります。
- name: orders_by_date
title
このセクションでは、ダッシュボード要素の一部である
titleパラメータについて説明します。
titleは、ダッシュボード パラメータのドキュメント ページで説明されているように、ダッシュボードの一部としても使用できます。
titleは、ダッシュボード パラメータのドキュメント ページで説明されているように、ダッシュボード フィルタの一部として使用することもできます。
title パラメータを使用すると、要素の名前がユーザーにどのように表示されるかを変更できます。指定しない場合、タイトルはデフォルトで要素 name になります。
次の例を考えてみましょう。
- name: sales_overview
title: '1) Sales Overview'
この形式を使用した場合、要素は [Sales Overview] ではなく [1) Sales Overview] と表示されます。
type
このセクションでは、ダッシュボード要素の一部である
typeパラメータについて説明します。
typeは、ダッシュボード パラメータのドキュメント ページで説明されているように、ダッシュボード フィルタの一部として使用することもできます。
typeは、type（結合の場合）パラメータのドキュメント ページで説明されているように、結合の一部としても使用できます。
typeは、ディメンション、フィルタ、パラメータ タイプのドキュメント ページで説明されているように、ディメンションの一部としても使用できます。
typeは、メジャーの型のドキュメント ページで説明されているように、メジャーの一部としても使用できます。
type パラメータは、要素で使用するビジュアリゼーションのタイプを決定します。
- name: element_name
type: text | looker_grid | table | single_value | looker_single_record |
looker_column | looker_bar | looker_scatter | looker_line | looker_area |
looker_pie | looker_donut_multiples | looker_funnel | looker_timeline |
looker_map | looker_google_map | looker_geo_coordinates | looker_geo_choropleth | looker_waterfall | looker_wordcloud | looker_boxplot
さまざまな種類の LookML ダッシュボード要素の概要については、type（LookML ダッシュボードの場合）のドキュメント ページをご覧ください。
height
このセクションでは、ダッシュボード要素の一部である
heightパラメータについて説明します。
heightは、ダッシュボード パラメータのドキュメント ページで説明されているように、ダッシュボード行の一部としても使用できます。
tile または static レイアウトのダッシュボードの場合
height パラメータは、layout: tile ダッシュボードと layout: static ダッシュボードの要素の高さを tile_size 単位（ピクセル単位で定義）で定義します。
たとえば、次のコードでは tile_size: 100 と height: 4 を指定し、orders_by_date 要素の高さを 400 ピクセルにしています。
- dashboard: sales_overview
tile_size: 100
...
elements:
- name: orders_by_date
height: 4
...
newspaper レイアウトのダッシュボードの場合
height パラメータは、layout: newspaper ダッシュボードの要素の高さを row 単位で定義します。
新聞レイアウトのダッシュボードでは、要素の高さはデフォルトで 6 行（約 300 ピクセル）になります。preferred viewer パラメータが dashboards-next に設定されているダッシュボードの最小の高さは 1 行です。最小の高さは、preferred viewer パラメータが dashboards に設定されているダッシュボードの場合、2 行です。
たとえば、次のコードでは、要素を 12 行の高さに設定します。これは、デフォルトに設定されている他の要素の 2 倍の高さです。
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
height: 12
...
width
このセクションでは、ダッシュボード要素の一部である
widthパラメータについて説明します。
widthは、ダッシュボード パラメータのドキュメント ページで説明されているように、ダッシュボードの一部としても使用できます。
width パラメータは、layout: tile ダッシュボードと layout: static ダッシュボードの要素の幅を tile_size 単位で定義します。
たとえば、次のコードでは tile_size: 100 と width: 4 を指定し、orders_by_date 要素の幅を 400 ピクセルにしています。
- dashboard: sales_overview
tile_size: 100
...
elements:
- name: orders_by_date
width: 4
...
width パラメータは、layout: newspaper ダッシュボードの要素の幅を列単位で定義します。
新聞レイアウトのダッシュボードのデフォルトの幅は 24 列です。
たとえば、次のコードは、要素をダッシュボードの幅の半分に設定します。
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
width: 12
...
top
top パラメータは、layout: static ダッシュボードの要素の上から下の位置を tile_size 単位で定義します。
たとえば、次のコードでは tile_size: 100 と top: 4 を指定し、orders_by_date 要素の上端をダッシュボードの上端から 400 ピクセル離して配置しています。
- dashboard: sales_overview
tile_size: 100
...
elements:
- name: orders_by_date
top: 4
...
left
left パラメータは、layout: static ダッシュボードの要素の左から右への位置を tile_size 単位で定義します。
たとえば、次のコードでは tile_size: 100 と left: 4 を指定し、orders_by_date 要素の左端をダッシュボードの左端から 400 ピクセル離して配置しています。
- dashboard: sales_overview
tile_size: 100
...
elements:
- name: orders_by_date
left: 4
...
row
layout: newspaper ダッシュボードの場合、row パラメータは要素の上端が配置される行を定義します。
ダッシュボードは、ダッシュボードの上部にある行 0 から始まります。新聞レイアウトのダッシュボードでは、要素の高さはデフォルトで 6 行になります。つまり、ダッシュボードの上部にあるダッシュボード要素（row: 0）は、デフォルトで 0 ～ 5 行を占有します。
各行の高さは 50 ピクセルです。つまり、6 行の要素のデフォルトの高さは 300 ピクセルです。
たとえば、次のコードは、要素がデフォルトの高さで設定されていると仮定して、ダッシュボードの 2 行目の要素に設定される要素を設定します。
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
row: 6
...
col
layout: newspaper ダッシュボードの場合、col パラメータは要素の左端が配置される列を定義します。
ダッシュボードは 24 列に分割されます。ダッシュボードは、ダッシュボードの左側の列 0 から始まります。新聞レイアウトのダッシュボードでは、要素の幅はデフォルトで 8 列になります。つまり、ダッシュボードの左側にあるダッシュボード要素（col: 0）は、デフォルトで 0 ～ 7 列を占有します。
たとえば、次のコードでは、ダッシュボードの 3 列目の要素に設定される要素を設定します。
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
col: 16
...
refresh
このセクションでは、ダッシュボード要素の一部である
refreshパラメータについて説明します。
refreshは、ダッシュボード パラメータのドキュメント ページで説明されているように、ダッシュボードの一部としても使用できます。
refresh パラメータを使用すると、要素を定期的に自動的に再読み込みして、最新のデータを取得できます。これは、オフィス内のテレビなど、ダッシュボードが常に表示される設定で役立ちます。このパラメータを有効にするには、ダッシュボードがブラウザ ウィンドウで開いている必要があります。この設定は、ダッシュボード キャッシュを「事前ウォーミング」するためにバックグラウンドで実行されません。
更新頻度は、秒、分、時間、日の任意の整数値で指定できます。次に例を示します。
- name: orders_by_date
refresh: 2 hours
短い更新間隔を設定する場合は注意してください。要素の背後にあるクエリがリソースを大量に消費する場合、特定の要素がデータベースに過度の負荷をかける可能性があります。
note
次のように、要素に説明用のメモを追加できます。
- name: element_name
note:
text: 'note text'
state: collapsed | expanded
display: above | below | hover
note には、text、state、display のサブパラメータがあります。
text
text サブパラメータは、メモに表示するテキストを指定します。テキストはローカライズできます。
state
state サブパラメータは、要素の幅内で 1 行に収まらない場合に、メモを collapsed にするか expanded にするかを決定します。collapsed を選択し、メモが長すぎる場合は、メモの末尾にクリック可能な省略記号（...）が表示され、これを使用してメモ全体を読むことができます。
display
display サブパラメータは、要素のどこにメモを表示するかを決定します。above は要素の上部にメモを配置し、below は要素の下部にメモを配置します。hover では、ユーザーが要素にマウスを合わせるとメモが表示されます。
クエリ パラメータ
type: looker_timeline の LookML ダッシュボード要素を定義する場合は、少なくとも model と explore のクエリ パラメータの値を指定する必要があります。クエリには、dimensions パラメータと measures パラメータの値も指定する必要があります。これには、名前などのラベル フィールドを表すディメンションが少なくとも 1 つと、開始フィールドと終了フィールド（日付または数値）が含まれます。Looker でタイムライン グラフを作成するための最小要件について詳しくは、タイムライン グラフのオプションのドキュメント ページをご覧ください。
model
model パラメータは、要素クエリに使用するモデルを定義します。指定しない場合、デフォルトでダッシュボードが存在するモデルが使用されます。
- name: orders_by_date
model: ecommerce
model パラメータは LookML 定数を受け取ります。プロジェクトのマニフェスト ファイルで定数を定義し、構文 "@{constant_name}" を使用して、定数を model の値として設定できます。定数を使用すると、モデルの名前を 1 か所で定義できます。これは、複数のダッシュボード要素で使用されているモデルの名前を更新する場合に特に便利です。
LookML ダッシュボードで定数を使用する方法の詳細と例については、constant パラメータのドキュメント ページをご覧ください。
explore
このセクションでは、ダッシュボード要素の一部である
exploreパラメータについて説明します。
exploreは、exploreパラメータのドキュメント ページで説明されているように、モデルの一部としても使用できます。
exploreは、ダッシュボード パラメータのドキュメント ページで説明されているように、ダッシュボード フィルタの一部として使用することもできます。
explore パラメータは、要素クエリに使用する Explore を定義します。
- name: orders_by_date
explore: order
explore パラメータは LookML 定数を受け取ります。プロジェクトのマニフェスト ファイルで定数を定義し、構文 "@{constant_name}" を使用して、定数を explore の値として設定できます。定数を使用すると、Explore の名前を 1 か所で定義できます。これは、複数のダッシュボード要素で使用されている Explore の名前を更新する場合に特に便利です。
LookML ダッシュボードで定数を使用する方法の詳細と例については、constant パラメータのドキュメント ページをご覧ください。
dimensions
dimensions パラメータは、要素クエリに使用するディメンションを定義します。ディメンションを指定するには、構文 view_name.dimension_name を使用します。クエリがない場合は、dimensions を含めないでください。
## single dimension example
- name: orders_by_date
dimensions: order.order_date
## multiple dimension example
- name: orders_by_date
dimensions: [order.order_date, customer.name]
measures
measures パラメータは、要素クエリに使用するメジャーを定義します。view_name.measure_name 構文を使用して、指標を指定します。クエリがない場合は、measures を含めないでください。
## single measure example
- name: orders_by_date
measures: order.count
## multiple measure example
- name: orders_by_date
measures: [order.count, order_item.count]
sorts
sorts パラメータは、要素クエリに使用する並べ替えを定義します。最初の並べ替えが最初に表示され、次に 2 番目の並べ替えが表示されます。ディメンションまたは指標を指定するには、構文 view_name.field_name を使用します。Looker のデフォルトの並べ替え順を使用する場合は、sorts を含めないでください。降順の並べ替えには desc というサフィックスが付きます。昇順の並べ替えにはサフィックスは必要ありません。
## single sort example
- name: orders_by_date
sorts: order.order_date desc
## multiple sort example
- name: orders_by_date
sorts: [order.order_date desc, customer.name]
pivots
pivots パラメータは、要素クエリでピボットするディメンションを定義します。ディメンションを指定するには、構文 view_name.dimension_name を使用します。クエリがない場合は、pivots を含めないでください。
## single pivot example
- name: orders_by_date
pivots: customer.gender
## multiple pivot example
- name: orders_by_date
pivots: [customer.gender, customer.age_tier]
limit
limit パラメータは、要素クエリに使用する行の上限を定義します。この上限は、ピボットが適用される前の行数に適用されます。
- name: orders_by_date
limit: 100
filters
このセクションでは、ダッシュボード要素の一部である
filtersパラメータについて説明します。
filtersは、ダッシュボード パラメータのドキュメント ページで説明されているように、ダッシュボードの一部としても使用できます。
filtersは、filtersパラメータのドキュメント ページで説明されているように、メジャーの一部としても使用できます。
filters パラメータは、要素のクエリに使用する変更不可のフィルタを定義します。ユーザーがダッシュボードで変更できるフィルタが必要な場合は、ダッシュボード用の filters を使用してフィルタを設定し、listen を使用して要素に適用する必要があります。
filters の構文は次のとおりです。
- name: element_name
filters:
orders.created_date: 2020/01/10 for 3 days
orders.status: Shipped
# You can create multiple filter statements
各フィルタでは、Looker のフィルタ式または値定数を使用できます。柔軟なフィルタ値のフィルタ式で _localization または _user_attributes Liquid 変数を使用することもできます。
listen
ダッシュボード フィルタを使用すると、ダッシュボードの要素に表示されるデータをインタラクティブに絞り込むことができます。LookML ダッシュボードの filters パラメータを使用してダッシュボード フィルタを定義します。次に、listen パラメータを使用して、ダッシュボード要素をダッシュボード フィルタにリンクします。
listen の構文は次のとおりです。
- name: element_name
listen:
filter_name_goes_here: dimension or measure on which to apply
the filter using view_name.field_name syntax
# You can add more than one listen statement
listen パラメータを要素に追加し、view_name.field_name 構文を使用して、フィルタの名前、コロン、フィルタを適用するフィールドへの参照を指定します。たとえば、ユーザーが UI のフィルタ フィールドに日付を入力する必要がある [日付] というフィルタを作成できます。ユーザーが入力した値を orders_by_date 要素に適用するには、次のようにします。
- dashboard: sales_overview
...
filters:
- name: date
type: date_filter
elements:
- name: orders_by_date
listen:
date: order.order_date
...
filters パラメータと listen パラメータを使用してダッシュボード フィルタを個々のダッシュボード要素に適用するその他の例については、LookML ダッシュボードの作成をご覧ください。
query_timezone
query_timezone パラメータは、クエリが実行されるタイムゾーンを指定します。タイムゾーン オプションについては、timezone の値のドキュメント ページをご覧ください。ビューアのタイムゾーンを使用してクエリを実行する場合は、値を user_timezone として割り当てます。
- name: orders_by_date
query_timezone: America/Los Angeles
- name: orders_by_customer
query_timezone: user_timezone
merged_queries
merged_queries パラメータを使用すると、複数のクエリの結果を 1 つのダッシュボード要素に結合できます。要素の merged_queries パラメータ内で各ソースクエリを定義し、join_fields サブパラメータを使用して結果をどのようにマージするかを指定します。
次のサンプル LookML コードは、結合された結果の type: looker_grid 要素を作成します。この例では、merged_queries パラメータを使用して、2 つの別々のクエリのデータを 1 つのテーブルグラフに結合するダッシュボード要素を作成します。
- name: merged_results_element
title: Merged Results Tile
type: looker_grid
merged_queries:
- model: ecommerce
explore: users
type: table
fields: [users.state, users.count, users.city]
sorts: [users.count desc 0]
limit: 5000
column_limit: 50
query_timezone: UTC
listen:
- State: users.state
- model: ecommerce
explore: users
type: table
fields: [users.state, users.city]
sorts: [users.state]
limit: 500
column_limit: 50
query_timezone: UTC
join_fields:
- field_name: users.state
source_field_name: users.state
- field_name: users.city
source_field_name: users.city
listen:
- State: users.state
この例では、ダッシュボード要素は ecommerce モデルの users Explore に基づく 2 つのソースクエリのデータを結合します。プライマリ クエリには users.state、users.count、users.city の各フィールドが含まれており、結果は users.count フィールドで並べ替えられます。2 つ目のソースクエリには users.state フィールドと users.city フィールドが含まれており、結果は users.state フィールドで並べ替えられます。
join_field パラメータは、users.state フィールドと users.city フィールドの一致する値に基づいて、ソースクエリを統合します。
listen パラメータは両方のクエリに State フィルタを適用します。これにより、ダッシュボードの閲覧者は特定の州を選択して、ダッシュボード タイルに表示されるクエリ結果を絞り込むことができます。
例: 会社データの統合
2 つの異なる Explore（company_info と companies）の会社に関する情報を結合するマージされたクエリを作成するとします。各探索の ipo.stock_symbol、companies.name、companies.contact_email フィールドでクエリを結合して、会社名、会社の連絡先メールアドレス、IPO 年、株価記号、従業員数、求人数に関する結果を返すクエリを作成します。LookML で結合されたクエリ要素を定義する方法は次のとおりです。
- name: merged_results_element
title: Merged Results Tile
merged_queries:
- model: market_research
explore: company_info
fields: [companies.name, companies.contact_email, ipo.public_year, ipo.stock_symbol]
filters:
companies.contact_email: "-NULL"
ipo.valuation_amount: NOT NULL
sorts: [ipo.public_year desc]
- model: company_data
explore: companies
fields: [companies.name, ipo.stock_symbol, companies.contact_email,
companies.number_of_employees, jobs.job_count]
filters:
companies.number_of_employees: NOT NULL
ipo.stock_symbol: "-NULL"
companies.contact_email: "-NULL"
sorts: [jobs.job_count desc]
join_fields:
- field_name: ipo.stock_symbol
source_field_name: ipo.stock_symbol
- field_name: companies.name
source_field_name: companies.name
- field_name: companies.contact_email
source_field_name: companies.contact_email
結合されたクエリ要素にフィルタを適用する
結合されたクエリ要素の前の例では、filters パラメータを使用して、各ソースクエリ内でハードコードされたフィルタを直接適用する方法を示しています。たとえば、メインクエリの companies.contact_email: "-NULL" フィルタと ipo.valuation_amount: NOT NULL フィルタは、有効な連絡先メールと評価を持つ企業に結果を制限します。これらのクエリレベルのフィルタは、クエリを統合する前にデータを事前フィルタリングするもので、ユーザーが変更することはできません。
また、各ソースクエリの定義内で listen パラメータを使用することで、統合されたクエリ要素にダッシュボード フィルタを適用することもできます。たとえば、LookML ダッシュボードの filters パラメータを使用してダッシュボード レベルで定義した Industry という名前のダッシュボード フィルタがあるとします。
filters:
- name: Industry
title: Industry
type: field_filter
ui_config:
type: dropdown_menu
display: inline
model: market_research
explore: company_info
field: companies.industry
両方のソースクエリの companies.industry フィールドに Industry フィルタを適用するには、次のように、マージされたクエリのソースクエリ定義ごとに listen パラメータを追加します。
listen:
Industry: companies.industry
たとえば、次のサンプルコードでは、前の例の結合結果要素のソースクエリの両方に Industry フィルタを追加します。
- name: merged_results_element
title: Merged Results Tile
merged_queries:
- model: market_research
explore: company_info
fields: [companies.name, companies.contact_email, ipo.public_year, ipo.stock_symbol]
filters:
companies.contact_email: "-NULL"
ipo.valuation_amount: NOT NULL
sorts: [ipo.public_year desc]
listen:
Industry: companies.industry
- model: company_data
explore: companies
fields: [companies.name, ipo.stock_symbol, companies.contact_email,
companies.number_of_employees, jobs.job_count]
filters:
companies.number_of_employees: NOT NULL
ipo.stock_symbol: "-NULL"
companies.contact_email: "-NULL"
sorts: [jobs.job_count desc]
join_fields:
- field_name: ipo.stock_symbol
source_field_name: ipo.stock_symbol
- field_name: companies.name
source_field_name: companies.name
- field_name: companies.contact_email
source_field_name: companies.contact_email
listen:
Industry: companies.industry
この追加により、ユーザーが Industry ダッシュボード フィルタを操作すると、結合されたクエリ要素内の対応するソースクエリがフィルタされます。
hidden_fields
hidden_fields パラメータは、クエリで使用されているがグラフに表示されないフィールドがあるかどうかを示します。非表示のフィールドは、Explore のデータテーブル セクションに表示されます。
hidden_fields: [inventory_items.count, distribution_centers.id]
オプション パラメータ
このセクションで説明するパラメータのほとんどは、タイムライン グラフのビジュアリゼーション エディタの [オプション] セクションのオプションに対応しています。
color_application
color_application パラメータとそのサブパラメータ collection_id と palette_id を使用して、特定のカラー コレクションとパレットをダッシュボード要素に適用できます。Looker のネイティブ カラー コレクションの概要については、カラー コレクションのドキュメント ページをご覧ください。
使用するパレットのコレクション ID とパレット ID がある場合は、これらの ID を collection_id サブパラメータと palette_id サブパラメータに入力できます。コレクション ID またはパレット ID は、英数字コードにすることも、カラー コレクションの名前に基づくものにすることもできます。英数字コードは、Looker のネイティブ コレクションに使用されます。これらはインスタンス固有であり、次のような形式になります。
color_application:
collection_id: 1297dk12-86a7-4xe0-8dfc-82de20b3806a
palette_id: 93c8aeb7-3f8a-4ca7-6fee-88c3617516a1
カスタム カラー コレクションでは、カラー コレクションの名前に基づくコレクション ID とパレット ID が使用されます。これらはインスタンス間で移植可能で、次のような形式になります。
color_application:
collection_id: blue-tone-collection
palette_id: blue-tone-collection-categorical-0
UI を使用して、必要な色、コレクション、パレットを見つけ、LookML を生成してダッシュボードに追加することもできます。ユーザー定義コンテンツ（Look、ダッシュボード、Explore など）に移動し、UI を使用して、そのコンテンツの可視化に目的の色、コレクション、パレットを適用します。完了したら、ダッシュボードの LookML を取得する手順に沿って、生成された LookML をコピーし、color_application セクションに貼り付けます。
groupBars
各レコードのバーを個別の行に表示するか、各ラベル値のレコードのバーをすべて同じ行に表示するかを決定します。groupBars を true に設定すると、同じラベル値を共有するすべてのレコードが、可視化の同じ行に個別のバーとして表示されます。
groupBars: true | false
labelSize
ラベルのフォントサイズを指定します。次に例を示します。
labelSize: 12pt
valueFormat
値の数値形式または日付形式を指定します。このパラメータでは Excel 形式の書式設定を使用できます。形式が指定されていない場合、値は基になるディメンションまたはメジャーの形式で表示されます。
showLegend
凡例はビジュアリゼーションの下部に表示できます。
showLegend: true | false