このページでは、dashboard.lkml ファイルの LookML ダッシュボード パラメータを使用して、type: text の LookML ダッシュボードの要素を追加してカスタマイズする方法について説明します。
Looker UI を使用してダッシュボードにテキストを追加する方法については、ユーザー定義のダッシュボードの作成のドキュメント ページをご覧ください。
使用例
## BASIC PARAMETERS
name: element_name
type: text
height: N
width: N
top: N
left: N
row: N
col: N
## TEXT PARAMETERS
title_text: title text
subtitle_text: subtitle text
body_text: body text
パラメータの定義
| パラメータ名 | 説明 | |
|---|---|---|
| 基本パラメータ | ||
name(要素の場合) |
要素を作成します。 | |
type(要素の場合) |
要素で使用する可視化のタイプを決定します。 | |
height(要素の場合) |
layout: tile ダッシュボードと layout: static ダッシュボードの要素の高さを tile_size 単位で定義します。 |
|
width(要素の場合) |
layout: tile ダッシュボードと layout: static ダッシュボードの要素の幅を tile_size 単位で定義します。 |
|
top |
layout: static ダッシュボードの tile_size 単位で要素の上から下への位置を定義します |
|
left |
layout: static ダッシュボードの tile_size 単位で要素の左から右への位置を定義します |
|
row |
layout: newspaper ダッシュボードの要素の上下位置を行単位で定義します |
|
col |
layout: newspaper ダッシュボードの要素の左右の位置を列単位で定義します |
|
| テキスト パラメータ | ||
title_text |
type: text のダッシュボードの要素のタイトルを指定します。 |
|
subtitle_text |
type: text のダッシュボードの要素のサブタイトルを指定します。 |
|
body_text |
type: text のダッシュボードの要素の本文テキストを指定します。 |
|
基本パラメータ
type: text の LookML ダッシュボードの要素を定義する場合は、少なくとも name パラメータと type パラメータの値を指定する必要があります。
name
このセクションでは、ダッシュボードの要素の一部である
nameパラメータについて説明します。
nameは、ダッシュボード パラメータのドキュメント ページで説明されているように、ダッシュボード フィルタの一部として使用することもできます。
name 宣言ごとに、新しいダッシュボードの要素が作成され、名前が割り当てられます。要素名は一意である必要があります。名前は、layout: grid ダッシュボードを使用している場合は elements パラメータで参照されることがあります。また、要素をタイルグループ(type: group)に編成している場合は、子要素の group パラメータで参照されることがあります。
- name: orders_by_date
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 | button | group
さまざまなタイプの 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 ダッシュボードの要素の高さを行単位で定義します。
新聞レイアウトのダッシュボードでは、要素の高さはデフォルトで 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 パラメータは、要素の上端が配置される行を定義します。group パラメータを使用して要素がタイルグループ内に配置されている場合、row は、グループ コンテナ(row: 0)の上部を基準とした要素の行位置を定義します。
ダッシュボードは、ダッシュボードの上部にある行 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 パラメータは、要素の左端が配置される列を定義します。group パラメータを使用して要素がタイルグループ内に配置されている場合、col は、グループ コンテナ(col: 0)の左端を基準とした要素の列位置を定義します。
ダッシュボードは 24 列に分割されています。ダッシュボードは、ダッシュボードの左側の列 0 から始まります。新聞レイアウトのダッシュボードでは、ダッシュボードの要素の幅がデフォルトで 8 列になります。つまり、ダッシュボードの左側にあるダッシュボードの要素(col: 0)は、デフォルトで 0 ~ 7 列を占有します。
たとえば、次のコードは、ダッシュボードの要素の 3 番目の列に設定される要素を設定します。
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
col: 16
...
テキスト パラメータ
Looker UI の [テキスト] オプションで作成されたテキストタイルから生成されたダッシュボード LookML では、
title_textパラメータまたはsubtitle_textパラメータは使用されません。
このセクションで説明するパラメータを使用すると、type: text の LookML ダッシュボード要素にコンテンツを追加できます。
title_text
title_text パラメータは、使用可能な最大のフォントサイズで type: text 要素に表示されるテキストを指定します。タイルの上部に表示されます。
title_text: title text
subtitle_text
subtitle_text パラメータは、使用可能な中間のフォントサイズで type: text 要素に表示されるテキストを指定します。title_text が存在する場合、subtitle_text はその下に表示されます。
subtitle_text: subtitle text
body_text
body_text パラメータは、使用可能な最小フォントサイズで type: text 要素に表示されるテキストを指定します。このパラメータは、テキスト タイルの最後に表示されます。Markdown タイルで Markdown を使用するのドキュメント ページでは、テキストの書式設定や、テキストタイルへのリンクや画像の追加に使用できる Markdown の概要について説明しています。
body_text: body text