Skip to content

マークアップページの要素一覧 ​

マークアップページで書ける要素の一覧と、すべての要素に共通するルールを説明します。コードの書き方は記法を、式で使える関数と書式は式を参照してください。

一覧 ​

要素ごとの説明は、種類ごとのページにあります。

種類要素内容区分
制御If条件による出し分けcontrol
ElseIf前の条件が偽のときの、次の条件control
Elseどの条件も満たさないときの中身control
For結果の行ごとの繰り返しcontrol
Group行を列の値でグループ化するcontrol
データChartドキュメントページのチャートblock
SqlResultSQL ブロックの実行結果の表block
SqlViewSQL ブロックの実行結果を、子孫の要素で表示する枠block
設定CrossFilterクロスフィルタの設定―
CrossFilterColumn表の列の同期の設定―
ParameterOverrideパラメータの値の上書き―
値Delta増減を記号と色で示す値inline
Progress値と上限の比を示す横棒block
Sparkline値の並びを示す、軸のない小さな図block
入力Parameterパラメータの入力block
ParameterChartチャートの上で Parameter の値を選ぶ入力―
Select表示の状態の値の選択block
SelectOptionSelect の 1 つの選択肢―
Switch表示の状態のオン・オフblock
TextInput表示の状態の文字の入力block
NumberInput表示の状態の数値の入力block
Slider表示の状態の数値を選ぶスライダーblock
RangeSlider表示の状態の数値の範囲を選ぶスライダーblock
ParameterLinkクリックでパラメータを設定するリンクinline
ParameterLinkValueParameterLink で設定する 1 つのパラメータの値―
ViewStateLinkクリックで表示の状態を設定するリンクinline
ViewStateValueリンクで 1 つの表示の状態に設定する値―
Paginator表示の状態で切り替えるページネーションblock
ParameterPaginatorパラメータを設定するページネーションblock
レイアウトColumns子の横並びblock
Rows子の縦並びblock
Grid子の格子状の並びblock
Card枠付きのまとまりblock
Spacer余白block
Calloutアイコン付きの注記block
Divider区切りの横線block
Table要素を置ける表block
TableRow表の 1 行―
TableCell表の 1 セル―
開閉Tabsタブによる切り替えblock
Tab1 つのタブ―
Collapseその場で開閉する領域block
Popover親の要素にポップアップで表示する補足―
テキストText文字列block
Span文の一部の書式inline
Link外部のページか、ページの中の要素へのリンクinline
Br文の中の改行inline
Tag状態や区分を示す小さなラベルinline
Hint文の中に置く説明のアイコンinline
List箇条書き・番号付きの一覧block
ListItem一覧の 1 項目―
Breadcrumbパンくずリストblock
BreadcrumbItemパンくずリストの 1 項目―
Heading見出しblock
Quote引用block
図Tree指標を分解した木(KPI ツリー)block
TreeNode木の 1 つのノード―
TreeEdge親のノードからの線のラベル―
Flow段階を矢印でつないだ図block
FlowStepFlow の 1 つの段階―
FlowEdge前の段階からの矢印のラベル―
Timeline出来事を縦の線に並べた年表block
TimelineItem年表の 1 つの出来事―
Matrix2 つの軸で分けたマトリクスblock
MatrixCellマトリクスの 1 マス―
メディアImageURL で指定した画像block
UploadedImageアップロードした画像block

共通ルール ​

構造の表記 ​

要素のページの区分・親・子の欄は、次の記法で表します。

記法意味
block などその区分(記法の「構造上の区分」)
―専用の子要素(区分の欄)
TreeEdge などの要素名その要素
X1 個
X?0 個か 1 個
X*0 個以上
X+1 個以上
(X | Y)X か Y。*・+ を付けると、混ぜて書ける
X YX の後に Y を書く

「親と同じ」は、親の直下に書いたものとして、親の子のルールで検査されることを表します。ページの直下は、子に block を取る要素と同じように扱われます。

「SqlView の子孫」の欄は、<SqlView> の中に書けるかを表します。「可」は中と外のどちらにも書けます。「子孫のみ」は中にだけ、「直下のみ」は <SqlView> の直下にだけ書けます。「不可」は中に書けません。

子に block か inline を取る要素(<Card>・<Text> など)には、構造の表の子の欄に control がなくても、制御要素を書けます。ただし、inline を取る要素(<Text> など)の中には、<Group> は書けません。

値の形式 ​

属性の表は、次のように読みます。

  • 属性の欄の「(必須)」は、必ず書く属性を表します
  • 値の欄の「既定」は、書かなかったときの値です
  • 値の欄の「式」は、式を書けることと、その書き方(単一式か文字+式)を表します(記法の「書ける場所」)。値の欄が「式(…)」の属性は、値全体を単一式で書きます

値の欄では、次の形式を名前だけで表します。

形式書ける値
ObjectId16 進数 24 文字(6adfc86a4399ba326172de94 など)
識別子英字で始まり、英数字と _ だけからなる値(r・tier など)。予約語(row・rows・view・params・env・true・false・null・in・as・break・const・continue・else・for・function・if・import・let・loop・package・namespace・return・var・void・while・size)と、param_ で始まる値は使えません

文字の書式 ​

文字の書式(size・weight・color)は、指定しないときは親(<List> → <Text> → <Span>)の値を引き継ぎ、子で上書きできます。親の値を打ち消すときは、既定の値を書きます(weight="normal")。属性の表の既定は、引き継ぐ親がないときの値です。size は親の大きさによらず、同じ値なら同じ大きさになります。

文字の折り返し ​

文字を折り返すかどうかは、要素の中での文字の役割で決まります。

役割要素振る舞い
文章Text・Heading・List・Quote、Card・Callout・Collapse・MatrixCell・TimelineItem などの title幅に合わせて折り返します。単語や数値は、1 行に入りきらないときだけ途中で折り返します
値Delta、Progress の値折り返しません
ラベルTag、枠のタイトル(Chart・SqlResult・SqlView・UploadedImage)1 行に収め、入りきらない部分は … で省略します。ポインタを重ねると、全文を表示します

図の線や軸のラベル(TreeEdge・FlowEdge など)の折り返しは、要素ごとに決まっています。各要素の説明を参照してください。

Text に書いた数値も文章として扱い、幅が足りなければ折り返します。折り返したくないときは、textWrap="nowrap" を書きます。

  • <Text textWrap="nowrap">:1 行で表示し、入りきらない部分は … で省略します。KPI の大きな数値、日付、ID などに使います。表のセルでは省略せず、列が広がって、表は横にスクロールします
  • <Span textWrap="nowrap">:その部分を行の境目で分けません。数値と単位など、分けたくない短い塊に使います(<Span textWrap="nowrap">1,234 件</Span>)

<Text> に書いた値は中の <Span> が引き継ぎ、<Span textWrap="wrap"> で戻せます。<Br /> は、nowrap の中でも改行します。

配置の属性 ​

子を並べる要素では、その子要素に次の属性を書いて、大きさを指定できます。有効な属性は親によって異なります。有効でない親の子に書くと、検査でエラーになります。

属性値内容
grow整数(0 以上)
既定:1
兄弟のあいだで大きさを分け合う比。<Columns> の子と、height を書いた <Rows> の子で有効です。0 は中身の大きさのまま(<Heading> の横に置く segmented の <Parameter> など)
colSpan整数(1〜60)
既定:1
またぐ列の数。<Grid> の子で有効です
rowSpan整数(1〜60)
既定:1
またぐ行の数。<Grid> の子で有効です

リンクの移動先 ​

区分が block の要素に anchor を書くと、その要素を移動先にできます。

  • 次のときに、その要素へ移動します
    • リンク(<Link>・<ViewStateLink>・<ParameterLink>)の scrollTo に anchor の値を書き、クリックしたとき
    • ページの URL の末尾に #anchor:<anchor の値> を付けて開いたとき
  • 移動するときは、移動先を含むタブに切り替え、閉じた <Collapse>・<Tree> の枝・<Popover> を開きます。移動先が画面に収まっていなければスクロールし、一時的に強調して表示します
  • 同じ anchor は、ページの中で 1 つの要素にしか書けません
  • <For> の中の要素には書けません
  • <If>・<Else> の両方の分岐へ移動したいときは、外側の要素に書きます
属性値内容
anchor英数字・_・-scrollTo に書いて、この要素を移動先にする値

デザイントークン ​

見た目を決める属性の多くは、次のトークンから値を選びます。色や大きさは直接指定できません。要素によっては、ほかの値も書けます(Callout の color の info など)。書ける値は、各要素の属性の表を参照してください。

種類値内容
文字の大きさ
(size)
sm / md / lg / xl / 2xlmd が本文の大きさで、ノートブックのテーマの文字サイズに合わせて変わります。テーマの文字サイズが既定(12px)のときは、sm から順に 12・14・16・32・40px です。xl 以上は KPI のような大きな数値に使い、見出しより大きく、行の高さを詰めます
文字の太さ
(weight)
normal / boldnormal は標準、bold は太字
色
(color)
default / muted / danger / warning / successdanger・warning・success は、KPI チャートの比較と同じく、ノートブックのカラーパレットの色です。既定のパレットでは success は青で、緑にしたいときはパレットで変えます
余白
(gap・padding)
none / xs / sm / md / lg / xl余白の大きさ。none から順に 0・4・8・12・16・24px です
背景色
(background)
default / none / muted / success / warning / dangermuted は薄い灰色、success・warning・danger はノートブックのカラーパレットの色を薄くした色です。backgroundIntensity で濃さを変えられます。0.0(塗らない)〜1.0(最も濃い)の値を書き、0.0 より小さい値は 0.0、1.0 より大きい値は 1.0 として扱います。NULL のときは塗りません。background に default・none 以外を書いたときだけ書けます
枠線
(border)
none / default / strongdefault は細い線、strong は濃い線
角丸
(radius)
none / md / lgmd・lg の順に丸くなります

Codatum CLI AIエージェントのための分析環境