Appearance
マークアップページの要素(設定)
親のチャートや表に付ける設定(パラメータの上書きとクロスフィルタ)。
すべての要素に共通するルール(構造の表記、配置の属性、デザイントークン)は、要素一覧を参照してください。
CrossFilter
親のチャートや表のクロスフィルタの設定です。キーの意味は、.cnb.md のチャートの crossFilter と同じです。
構造
| 項目 | 内容 |
|---|---|
| 区分 | ― |
| 親 | Chart | SqlResult |
| 子 | CrossFilterColumn* |
SqlView の子孫 | 不可 |
属性
| 属性 | 値 | 内容 |
|---|---|---|
syncLegendKey | 文字列 | 凡例の選択を同期するキー |
syncXAxisKey | 文字列 | x 軸の選択を同期するキー |
syncYAxisKey | 文字列 | y 軸の選択を同期するキー |
syncFrameKey | 文字列 | 枠の選択を同期するキー |
例
html
<Chart id="…" page="…" chart="…">
<CrossFilter syncLegendKey="region" />
</Chart>CrossFilterColumn
表の列を、クロスフィルタで同期します。.cnb.md の crossFilter の syncColumns と同じです。
構造
| 項目 | 内容 |
|---|---|
| 区分 | ― |
| 親 | CrossFilter |
| 子 | なし(/> で閉じる) |
SqlView の子孫 | 不可 |
属性
| 属性 | 値 | 内容 |
|---|---|---|
syncKey(必須) | 文字列 | 同期するキー |
tableFieldKey(必須) | 文字列 | 列の名前(<SqlResult>)か、列のキー(表のチャート) |
ParameterOverride
親がクエリを実行するときに、パラメータの値を上書きします。value を書くと固定の値で、from を書くと別のパラメータの値で上書きします。
構造
| 項目 | 内容 |
|---|---|
| 区分 | ― |
| 親 | Chart | SqlResult | SqlView |
| 子 | なし(/> で閉じる) |
SqlView の子孫 | 直下のみ |
使い方
valueとfromは、どちらか一方だけを書きます- 上書きされるのは、親の SQL ブロックが使っているパラメータ(SQL ブロック属性の bindings の refParamKey)だけです。使っていないパラメータを書いても、エラーにはなりません。上書きした SQL は
cdm notebook build-sqlで確認できます
属性
| 属性 | 値 | 内容 |
|---|---|---|
param(必須) | ObjectId | 上書きするパラメータの ID。日付の範囲は、開始日と終了日を別の ParameterOverride で上書きし、ID の後に .0(開始日)か .1(終了日)を付けます |
value | 文字列 | 上書きに使う固定の値。JSON として解釈し、解釈できない値は文字列として扱います(null は SQL の NULL、1.0 は数の 1 になります)。書いたとおりの文字列にしたいときは、value='"1.0"' のように JSON の文字列で書きます。上書きするパラメータの種類に合わない値(複数選択に value="JP" を書いた場合など)は、エラーになります |
from | ObjectId | 値を取るパラメータの ID(ノートブック共通か、このページ固有)。日付の範囲は、ID の後に .0・.1 を付けます |
page | ObjectId | 上書きする SQL ブロックがあるドキュメントページの ID。親の SQL ブロックが参照する、ほかのページの SQL ブロックのパラメータを上書きするときに書きます。未指定時は、親の page です |
例
html
<Chart id="…" page="…" chart="…">
<ParameterOverride param="…" value="JP" />
<ParameterOverride param="…" from="…" />
</Chart>