マークアップページの要素（データ）

ドキュメントページで定義したチャートや SQL ブロックの実行結果を表示する要素。

すべての要素に共通するルール（構造の表記、配置の属性、デザイントークン）は、要素一覧を参照してください。

Chart

ドキュメントページで定義したチャートを表示します。

構造

項目	内容
区分	block
親	子に block を取る要素
子	CrossFilter? ParameterOverride*
SqlView の子孫	不可

属性

属性	値	内容
id（必須）	ObjectId	要素の ID（記法の「要素の ID」）
page（必須）	ObjectId	ドキュメントページの ID
chart（必須）	ObjectId	page の中のチャートの ID
name	文字列 式：文字＋式	枠のタイトル。未指定時は、チャートの名前です
hideFrame	真偽値	枠を非表示にします
hideName	真偽値	枠のタイトルを非表示にします
description	文字列 式：文字＋式	タイトルや枠の横の ? のアイコンで表示する説明。PDF には表示されません
height	px（例：320px） 既定：360px	高さ

例

<Chart id="…" page="…" chart="…" />

SqlResult

ドキュメントページで定義した SQL ブロックの実行結果を、表で表示します。セルの見た目を調整したいときは、<SqlView> の中で <Table> を使います。

構造

項目	内容
区分	block
親	子に block を取る要素
子	CrossFilter? ParameterOverride*
SqlView の子孫	不可

属性

属性	値	内容
id（必須）	ObjectId	要素の ID（記法の「要素の ID」）
page（必須）	ObjectId	ドキュメントページの ID
sql（必須）	ObjectId	page の中の SQL ブロックの ID
name	文字列 式：文字＋式	枠のタイトル。未指定時は、SQL ブロックの名前から作ったタイトル（Result of <SQL ブロック名>）です
hideFrame	真偽値	枠を非表示にします
hideName	真偽値	枠のタイトルを非表示にします
description	文字列 式：文字＋式	タイトルや枠の横の ? のアイコンで表示する説明。PDF には表示されません
height	px（例：320px） 既定：360px	高さ

例

<SqlResult id="…" page="…" sql="…" height="480px" />

SqlView

ドキュメントページで定義した SQL ブロックの実行結果を、子孫に書いた要素で表示します。KPI の数字、データによって変わる文、行ごとに作るカードや一覧、セルの見た目を調整した表などに使います。

構造

項目	内容
区分	block
親	子に block を取る要素
子	ParameterOverride* block*
SqlView の子孫	不可

使い方

• 子孫の式から結果の行を参照する方法は、記法の「行の参照」を参照してください
• <SqlView> は、数行から数十行の結果に使います。<For> で作る要素が多いと、表示が重くなります。結果を表でそのまま表示するときや、行の多い明細には <SqlResult> を使います

属性

属性	値	内容
id（必須）	ObjectId	要素の ID（記法の「要素の ID」）
page（必須）	ObjectId	ドキュメントページの ID
sql（必須）	ObjectId	page の中の SQL ブロックの ID
name	文字列 式：文字＋式	枠のタイトル
hideFrame	真偽値	枠を非表示にします
hideName	真偽値	枠のタイトルを非表示にします
description	文字列 式：文字＋式	タイトルや枠の横の ? のアイコンで表示する説明。PDF には表示されません
gap	none / xs / sm / md / lg / xl 既定：md	子の間隔
height	px（例：320px）	高さ

例

<SqlView id="…" page="…" sql="…" hideFrame>
  <Text size="2xl" weight="bold">{{ formatNumber(row.sales, "compact") }}</Text>
  <Text size="sm" color="muted">前月比 <Delta value="{{ row.mom }}" format=".1%" /></Text>
</SqlView>

<SqlView id="…" page="…" sql="…" hideFrame>
  <If condition="{{ row.mom < 0 }}">
    <Text color="danger">売上が前月より {{ formatNumber(-row.mom, "d3", ".1%") }} 減っています。</Text>
  </If>
  <Else>
    <Text>売上は前月より {{ formatNumber(row.mom, "d3", ".1%") }} 増えています。</Text>
  </Else>
</SqlView>