Appearance
マークアップページの要素(レイアウト)
ページの配置を決める要素。子を縦・横・格子に並べる要素、枠で囲む要素、区切りや余白、表などがあります。
すべての要素に共通するルール(構造の表記、配置の属性、デザイントークン)は、要素一覧を参照してください。
Columns
子を横に並べます。折り返さず、子の grow(配置の属性)の比で幅を分けます。
構造
| 項目 | 内容 |
|---|---|
| 区分 | block |
| 親 | 子に block を取る要素 |
| 子 | block* |
SqlView の子孫 | 可 |
使い方
- モバイル表示では、子が縦一列に並び、
verticalAlignは無視されます
属性
| 属性 | 値 | 内容 |
|---|---|---|
gap | none / xs / sm / md / lg / xl既定: lg | 子の間隔。既定はページの直下と同じ |
verticalAlign | start / center / end / stretch既定: stretch | 子の縦方向の配置。stretch は、高さを最も高い子にそろえます |
padding | none / xs / sm / md / lg / xl既定: none | 内側の余白 |
background | default / none / muted / success / warning / danger既定: default式:単一式 | 背景色 |
backgroundIntensity | 数値 式:単一式 | background の濃さ(0.0〜1.0)。デザイントークンを参照してください |
border | none / default / strong既定: none | 枠線 |
radius | none / md / lg既定: none | 角丸 |
height | px(例:320px) | 高さ |
例
html
<Columns verticalAlign="center">
<Heading id="…" level="2">推移</Heading>
<Parameter param="…" variant="segmented" autoRun hideFrame grow="0" />
</Columns>Rows
子を縦に並べます。height を書くと、子の grow(配置の属性)の比で高さを分けます。
構造
| 項目 | 内容 |
|---|---|
| 区分 | block |
| 親 | 子に block を取る要素 |
| 子 | block* |
SqlView の子孫 | 可 |
属性
| 属性 | 値 | 内容 |
|---|---|---|
gap | none / xs / sm / md / lg / xl既定: lg | 子の間隔。既定はページの直下と同じ |
padding | none / xs / sm / md / lg / xl既定: none | 内側の余白 |
background | default / none / muted / success / warning / danger既定: default式:単一式 | 背景色 |
backgroundIntensity | 数値 式:単一式 | background の濃さ(0.0〜1.0)。デザイントークンを参照してください |
border | none / default / strong既定: none | 枠線 |
radius | none / md / lg既定: none | 角丸 |
height | px(例:320px) | 高さ |
Grid
子を格子に並べます。子は、書いた順に左上から詰めて配置されます。大きさは、子の colSpan・rowSpan(配置の属性)で指定します。
構造
| 項目 | 内容 |
|---|---|
| 区分 | block |
| 親 | 子に block を取る要素 |
| 子 | block* |
SqlView の子孫 | 可 |
使い方
- 12 列を基本にすると分けやすくなります
- 行の高さは、その行で最も高い子に合わせます
属性
| 属性 | 値 | 内容 |
|---|---|---|
cols(必須) | 整数(1〜60) | 列の数 |
gap | none / xs / sm / md / lg / xl既定: lg | 子の間隔。既定はページの直下と同じ |
padding | none / xs / sm / md / lg / xl既定: none | 内側の余白 |
background | default / none / muted / success / warning / danger既定: default式:単一式 | 背景色 |
backgroundIntensity | 数値 式:単一式 | background の濃さ(0.0〜1.0)。デザイントークンを参照してください |
border | none / default / strong既定: none | 枠線 |
radius | none / md / lg既定: none | 角丸 |
height | px(例:320px) | 高さ |
例
html
<Grid cols="12">
<Card title="売上" colSpan="4"><Text size="2xl" weight="bold">1.2億</Text></Card>
<Card title="注文数" colSpan="4"><Text size="2xl" weight="bold">3,456</Text></Card>
<Card title="解約率" colSpan="4"><Text size="2xl" weight="bold">1.8%</Text></Card>
</Grid>Card
枠付きのまとまりです。background の default は、カードの背景色になります。
構造
| 項目 | 内容 |
|---|---|
| 区分 | block |
| 親 | 子に block を取る要素 |
| 子 | Popover? block* |
SqlView の子孫 | 可 |
属性
| 属性 | 値 | 内容 |
|---|---|---|
title | 文字列 式:文字+式 | タイトル |
description | 文字列 式:文字+式 | タイトルや枠の横の ? のアイコンで表示する説明 |
gap | none / xs / sm / md / lg / xl既定: md | 子の間隔 |
padding | none / xs / sm / md / lg / xl | 内側の余白。書かなければ、上下は md、左右は lg になります |
background | default / none / muted / success / warning / danger既定: default式:単一式 | 背景色 |
backgroundIntensity | 数値 式:単一式 | background の濃さ(0.0〜1.0)。デザイントークンを参照してください |
border | none / default / strong既定: default | 枠線 |
radius | none / md / lg既定: md | 角丸 |
height | px(例:320px) | 高さ |
例
html
<Card title="売上" description="税抜">
<Text size="2xl" weight="bold">1.2億円</Text>
</Card>Spacer
要素の間に余白を作ります。
構造
| 項目 | 内容 |
|---|---|
| 区分 | block |
| 親 | 子に block を取る要素 |
| 子 | なし(/> で閉じる) |
SqlView の子孫 | 可 |
使い方
- 縦に空けるときは、
heightで高さを書きます - 要素を右に寄せるときは、
<Columns>の中で、寄せる要素の前にheightなしで置きます。寄せる要素にはgrow="0"を書きます。前後に置くと、中央に寄ります <Grid>の中にheightなしで置くと、1 セル分の空きになります
属性
| 属性 | 値 | 内容 |
|---|---|---|
height | px(例:320px) | 高さ。未指定時は高さを持たず、<Columns> の中では残りの幅を埋めます。埋める場所がないとき(縦に並ぶだけの場所や、モバイル表示の <Columns>)は表示されません |
例
html
<Text>前の段落</Text>
<Spacer height="40px" />
<Text>後の段落</Text>html
<Columns>
<Spacer />
<Select as="metric" grow="0">
<SelectOption value="sales" title="売上" default />
<SelectOption value="orders" title="注文数" />
</Select>
</Columns>Callout
定義、注意、データの欠損などを、本文と区別して示す注記です。
構造
| 項目 | 内容 |
|---|---|
| 区分 | block |
| 親 | 子に block を取る要素 |
| 子 | block* |
SqlView の子孫 | 可 |
属性
| 属性 | 値 | 内容 |
|---|---|---|
title | 文字列 式:文字+式 | 子の上に太字で表示するタイトル |
color | info / success / warning / danger既定: info式:単一式 | 注記の色。変わるのはアイコンとその色だけで、背景は同じです |
icon | 文字列(16 文字まで) | 色で決まるアイコンの代わりに表示する絵文字 |
gap | none / xs / sm / md / lg / xl既定: md | 子の間隔 |
例
html
<Callout color="warning" title="データの遅れ">
<Text>10/1 以降の注文は、集計に反映されていない。</Text>
</Callout>Divider
上下の要素を区切る横線を引きます。
構造
| 項目 | 内容 |
|---|---|
| 区分 | block |
| 親 | 子に block を取る要素 |
| 子 | なし(/> で閉じる) |
SqlView の子孫 | 可 |
使い方
<Columns>の子に置いても、縦の線にはなりません
属性
属性はありません。
Table
セルに要素を置ける表です。見た目を整えた順位表や、指標の一覧に使います。
構造
| 項目 | 内容 |
|---|---|
| 区分 | block |
| 親 | 子に block を取る要素 |
| 子 | (TableRow | control)+ |
SqlView の子孫 | 可 |
使い方
- どの行も、列の数(
<TableCell>のcolSpanの合計)をそろえます。<For>・<If>でセルを作る行は、列の数を検査しません - 列の幅は、最初の行のセルの
widthで決まります。widthのない列は、中身に合わせて残りの幅を分け合います - 幅に収まらないときは、表の中で横にスクロールします
- 狭い画面で文字の列が細く折り返されるときは、短い文字や数値の
<Text>にtextWrap="nowrap"を書くと、列が中身の幅を保ちます - 行が多いと表示が重くなります。
<For>のlimitで絞るか、<SqlResult>を使います - 並べ替えや絞り込みの機能はありません
属性
| 属性 | 値 | 内容 |
|---|---|---|
maxHeight | px(例:320px) | 高さの上限。超えると表の中でスクロールし、見出しの行は固定されます。PDF でも、はみ出た行は出力されません |
例
html
<SqlView id="…" page="…" sql="…">
<Table>
<TableRow header>
<TableCell width="160px"><Text>担当</Text></TableCell>
<TableCell align="end"><Text>売上</Text></TableCell>
</TableRow>
<For as="r" limit="10">
<TableRow>
<TableCell><Text>{{ r.name }}</Text></TableCell>
<TableCell align="end"><Text>{{ r.amount }}</Text></TableCell>
</TableRow>
</For>
<Else>
<TableRow>
<TableCell colSpan="2"><Text color="muted">該当なし</Text></TableCell>
</TableRow>
</Else>
</Table>
</SqlView>TableRow
<Table> の 1 行です。
構造
| 項目 | 内容 |
|---|---|
| 区分 | ― |
| 親 | Table |
| 子 | (TableCell | control)+ |
SqlView の子孫 | 可 |
使い方
<TableCell>にもbackgroundを書くと、行の塗りの上にセルの塗りを重ねます
属性
| 属性 | 値 | 内容 |
|---|---|---|
header | 真偽値 | セルを列の見出しとして表示します。<Table> の最初の行にだけ書けます(<If>・<For> の子の行には書けません) |
background | default / none / muted / success / warning / danger既定: default式:単一式 | 行の背景色 |
backgroundIntensity | 数値 式:単一式 | background の濃さ(0.0〜1.0)。デザイントークンを参照してください |
例
html
<SqlView id="…" page="…" sql="…">
<Table>
<For as="r">
<TableRow background="{{ r.risk == 'high' ? 'danger' : 'default' }}">
<TableCell><Text>{{ r.customer }}</Text></TableCell>
<TableCell><Text>{{ r.risk }}</Text></TableCell>
</TableRow>
</For>
</Table>
</SqlView>html
<SqlView id="…" page="…" sql="…">
<Table>
<TableRow header>
<TableCell><Text>指標</Text></TableCell>
<For as="r"><TableCell align="end"><Text>{{ r.month }}</Text></TableCell></For>
</TableRow>
<TableRow>
<TableCell><Text>売上</Text></TableCell>
<For as="r"><TableCell align="end"><Text>{{ formatNumber(r.sales, "compact") }}</Text></TableCell></For>
</TableRow>
<TableRow>
<TableCell><Text>前月比</Text></TableCell>
<For as="r"><TableCell align="end"><Text><Delta value="{{ r.mom }}" format=".1%" /></Text></TableCell></For>
</TableRow>
</Table>
</SqlView>TableCell
<TableRow> の 1 セルです。
構造
| 項目 | 内容 |
|---|---|
| 区分 | ― |
| 親 | TableRow |
| 子 | Popover? block* |
SqlView の子孫 | 可 |
使い方
- 値に応じた濃さで塗るとき(コホート表のようなヒートマップ)は、
backgroundIntensityに、値を列の最大値で割った値を書きます(backgroundIntensity="{{ r.rate / max(rows, 'rate') }}")
属性
| 属性 | 値 | 内容 |
|---|---|---|
align | start / center / end既定: start | セルの中の文字の横方向の配置。子孫の <Text> の align が優先されます |
width | px(例:320px) | 列の幅。最初の行のセルにだけ書けます。colSpan を書いたセルでは、またぐ列全体の幅になります |
colSpan | 整数(1 以上) 既定: 1 | セルがまたぐ列の数。<For> の後の <Else> の行や、合計の行などに使います |
gap | none / xs / sm / md / lg / xl既定: xs | 子の間隔 |
background | default / none / muted / success / warning / danger既定: default式:単一式 | 背景色 |
backgroundIntensity | 数値 式:単一式 | background の濃さ(0.0〜1.0)。デザイントークンを参照してください |
例
html
<SqlView id="…" page="…" sql="…">
<Table>
<For as="r">
<TableRow>
<TableCell><Text>{{ r.cohort_month }}</Text></TableCell>
<TableCell align="end" background="success" backgroundIntensity="{{ r.retention_m1 / max(rows, 'retention_m1') }}">
<Text>{{ formatNumber(r.retention_m1, "d3", ".1%") }}</Text>
</TableCell>
<TableCell
align="end"
background="{{ r.diff >= 0 ? 'success' : 'danger' }}"
backgroundIntensity="{{ abs(r.diff) / 0.2 }}"
>
<Text><Delta value="{{ r.diff }}" format=".1%" /></Text>
</TableCell>
</TableRow>
</For>
</Table>
</SqlView>