Skip to content

マークアップページの要素(入力) ​

閲覧者が値を選ぶ要素。<Parameter>・<ParameterLink>・<ParameterPaginator> はパラメータの値を変えます。<Select>・<Switch>・<TextInput>・<NumberInput>・<Slider>・<RangeSlider>・<Paginator>・<ViewStateLink> は表示の状態だけを変え、SQL には渡しません。

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

Parameter ​

パラメータの入力欄を表示します。

構造 ​

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

使い方 ​

  • 表示する名前と説明は、パラメータの定義のものです
  • データの推移や内訳を見ながら値を選べるようにしたいときは、子に <ParameterChart> を書きます。入力欄の下にチャートが表示され、チャートの上でも値を選べます

属性 ​

属性値内容
param(必須)ObjectIdパラメータの ID
variantdefault / segmented
既定:default
見た目。segmented は選択肢をボタンで並べます。単一選択のパラメータにだけ書けます。選択肢を SQL やテーブルから取得するパラメータと、モバイル表示では、segmented もドロップダウンになります
autoRun真偽値値が確定したときに自動で実行します。確定するのは、選択肢や日付を選んだときと、文字や数値の入力で Enter を押すかフォーカスが外れたときです
hideFrame真偽値枠を非表示にします
hideName真偽値枠のタイトルを非表示にします

例 ​

html
<Parameter param="…" variant="segmented" autoRun />

ParameterChart ​

ドキュメントページのチャートを親の <Parameter> にある入力欄の下に表示し、チャートの上でパラメータの値を選べるようにします。推移のチャートで期間をドラッグして選ぶ、カテゴリ別のチャートで棒や扇形を押して絞り込む値を選ぶ、といった使い方をします。チャートと入力欄は連動し、パラメータの今の値がチャートの上で強調されます。

構造 ​

項目内容
区分―
親Parameter
子なし(/> で閉じる)
SqlView の子孫不可

使い方 ​

  • 使えるパラメータとチャートの組み合わせは、次の表のとおりです。系列で分けた XY チャートは使えます。Y軸を分けたチャートと、ビューやフレームで分割したチャートは使えません
パラメータチャート選び方
日付範囲X軸が日付の XY チャートX軸に沿ってドラッグして期間を選ぶ。棒・点を押すと、その期間を選ぶ
テキスト入力・テキスト選択X軸がカテゴリの XY チャート、円グラフ・ドーナツ棒・点・扇形を押して、その値を選ぶ
  • 組み合わせの誤りは、次のように分かります
    • チャートの設定で分かる誤りは、書いた内容の検証(cdm notebook validate)でエラーになります
    • X軸の列の型が合わないときは、実行時の検証(cdm notebook run)でエラーになります。チャートの上にもメッセージが表示されます
  • 選ぶと、パラメータに次の値が設定されます
    • 日付範囲:選んだ棒・点の期間を、パラメータの単位(週・月など)の区切りまで広げた値。たとえば、月ごとのチャートで棒を押すと、その月の初日から末日になります
    • テキスト:表示の書式を適用する前の値
      • 選択肢を「値,ラベル」で定義したときは、カテゴリの列を値にそろえます
      • NULL と、テキストで定義した選択肢にない値は選べません
  • 選んでいる値と同じものを押すと、デフォルト値に戻ります。実行するかどうかは、親の <Parameter> の autoRun に従います
  • パラメータの現在の値は、チャートの上で強調されます
    • テキストの値に合う棒・点・扇形がないときは、すべてが薄く表示されます
    • 「すべて」は「ALL」のような値ではなく、未設定(空)で表します(値の解決)
  • チャートの SQL は、次のように書きます
    • 親の <Parameter> のパラメータでは絞りません。絞ると、チャートに選んだ範囲だけが表示され、ほかの値を選べなくなります
    • ほかのパラメータでは絞れます。KPI などのほかのチャートや表は、すべてのパラメータで絞ります(2 つ目の例)
  • 日付の X軸は、次のように作ります
    • 週ごとに丸めるときは、パラメータの週の開始曜日(dayStartOfWeek)をデータベースに合わせます(BigQuery は日曜、ほかの多くは月曜)。ずれると、1 本の棒で 2 週分が選ばれます
    • TIMESTAMP の列は、日・週・月・年で丸めます。丸めると、timestamp_timezone のタイムゾーンの日付になります。時・分で丸めたときと丸めないときは、閲覧者のタイムゾーンの日付になるため、見る人によって変わります
  • SQL を実行し直さずに、チャート同士で凡例や軸の選択を連動させるときは、<CrossFilter> を使います(表示の切り替え)

属性 ​

属性値内容
id(必須)ObjectId要素の ID(記法の「要素の ID」)
page(必須)ObjectIdドキュメントページの ID
chart(必須)ObjectIdpage の中のチャートの ID
heightpx(例:320px)
既定:360px
チャートの高さ

例 ​

html
<!-- 日付範囲のパラメータ -->
<Parameter param="…" autoRun>
  <!-- 選べる期間の全体の、日別の売上。ドラッグした期間が、パラメータに設定される -->
  <ParameterChart id="…" page="…" chart="…" height="200px" />
</Parameter>
<!-- パラメータの期間で絞り込んだ、カテゴリ別の売上 -->
<Chart id="…" page="…" chart="…" />
html
<!-- 期間(日付範囲)のパラメータ -->
<Parameter param="…" autoRun>
  <!-- 日別の売上。SQL は流入元で絞り、期間では絞らない -->
  <ParameterChart id="…" page="…" chart="…" height="200px" />
</Parameter>
<!-- 流入元(テキスト選択)のパラメータ -->
<Parameter param="…" autoRun>
  <!-- 流入元別の売上。SQL は期間で絞り、流入元では絞らない -->
  <ParameterChart id="…" page="…" chart="…" />
</Parameter>
<!-- KPI。SQL は期間と流入元の両方で絞る -->
<Chart id="…" page="…" chart="…" />

Select ​

表示の状態の値を 1 つ選びます。選んだ値で表示を変える部分は、<Select> の子ではなく <If> で書きます。

構造 ​

項目内容
区分block
親子に block を取る要素
子SelectOption+
SqlView の子孫可(For の中は不可)

使い方 ​

  • 枠付きの <Parameter> と並べて見た目をそろえるときは、<Card> で包み、タイトルを <Card> の title に書き、<Select> に width="full" を書きます

属性 ​

属性値内容
as(必須)識別子選んだ選択肢の値(value)を、式で view.<名前> として参照するための名前。同じ名前の要素は、状態を共有します
variantdefault / segmented
既定:default
見た目。default はドロップダウン、segmented はボタンの並び。モバイル表示では、segmented もドロップダウンになります
title文字列
式:文字+式
選択欄の前に表示するタイトル
widthpx(例:320px)・full
既定:240px
ドロップダウンの幅。full は親の幅いっぱいです(title を書いたときは、タイトルを除いた残りの幅)。親より広い値は、親の幅になります。variant が segmented のときは書けません

例 ​

html
<Select as="metric" variant="segmented">
  <SelectOption value="sales" title="売上" default />
  <SelectOption value="orders" title="注文数" />
</Select>
<If condition="{{ view.metric == 'orders' }}">
  <Text>注文数を表示中</Text>
</If>
<Else>
  <Text>売上を表示中</Text>
</Else>
html
<Columns>
  <Parameter param="…" />
  <Card title="指標">
    <Select as="metric" width="full">
      <SelectOption value="sales" title="売上" default />
      <SelectOption value="orders" title="注文数" />
    </Select>
  </Card>
</Columns>

SelectOption ​

<Select> の 1 つの選択肢です。

構造 ​

項目内容
区分―
親Select
子なし(/> で閉じる)
SqlView の子孫可(For の中は不可)

属性 ​

属性値内容
value(必須)英数字・_・-この選択肢を選んだときの view.<名前> の値。同じ <Select> の中で重複しない値にします
title(必須)文字列
式:文字+式
選択肢のタイトル
default真偽値最初に選ばれた状態にします。同じ <Select> の中で 1 つまで書けます。どの選択肢にも書かないときは、最初の選択肢が選ばれます

Switch ​

表示の状態をオン・オフします。オン・オフで表示を変える部分は、<If> で書きます。

構造 ​

項目内容
区分block
親子に block を取る要素
子なし(/> で閉じる)
SqlView の子孫可(For の中は不可)

属性 ​

属性値内容
as(必須)識別子オンかどうか(真偽値)を、式で view.<名前> として参照するための名前。同じ名前の要素は、状態を共有します
title(必須)文字列
式:文字+式
スイッチの右に表示するタイトル
default真偽値最初からオンにします

例 ​

html
<Switch as="compare" title="前年と比べる" />
<If condition="{{ view.compare }}">
  <Text size="sm" color="muted">前年比 +4.1%</Text>
</If>

TextInput ​

表示の状態に、閲覧者が入力した文字を持たせます。一覧を、入力した文字を含む行だけに絞り込む、といった操作に使います。

構造 ​

項目内容
区分block
親子に block を取る要素
子なし(/> で閉じる)
SqlView の子孫可(For の中は不可)

使い方 ​

  • 一覧を絞り込むときは、<For> の where に search(view.<名前>, [列, …]) を書きます。入力が空のときは、すべての行を表示します
  • SQL は実行し直さないので、絞り込めるのは受け取った行(1,000 行まで)だけです。それより多い行から探すときは、テキスト入力のパラメータを SQL の条件に使います
  • 枠付きの <Parameter> と並べて見た目をそろえるときは、<Card> で包み、タイトルを <Card> の title に書き、<TextInput> に width="full" を書きます

属性 ​

属性値内容
as(必須)識別子入力した文字を、式で view.<名前> として参照するための名前。同じ名前の要素は、状態を共有します
title文字列
式:文字+式
入力欄の前に表示するタイトル
placeholder文字列
式:文字+式
空のときに入力欄に表示する文字。何を入力するかを書きます(「商品名・カテゴリで検索」など)
default文字列最初に入っている文字。未指定時は空です
widthpx(例:320px)・full
既定:240px
入力欄の幅。full は親の幅いっぱいです(title を書いたときは、タイトルを除いた残りの幅)。親より広い値は、親の幅になります

例 ​

html
<TextInput as="q" placeholder="店舗名・地域で検索" />
<SqlView id="…" page="…" sql="…">
  <Paginator pageSize="20">
    <Table>
      <TableRow header>
        <TableCell><Text>店舗</Text></TableCell>
        <TableCell><Text>地域</Text></TableCell>
      </TableRow>
      <For as="r" where="{{ search(view.q, [r.store, r.region]) }}">
        <TableRow>
          <TableCell><Text>{{ r.store }}</Text></TableCell>
          <TableCell><Text>{{ r.region }}</Text></TableCell>
        </TableRow>
      </For>
      <Else>
        <TableRow><TableCell colSpan="2"><Text color="muted">「{{ view.q }}」に一致する店舗はありません</Text></TableCell></TableRow>
      </Else>
    </Table>
  </Paginator>
</SqlView>

NumberInput ​

表示の状態に、閲覧者が入力した数値を持たせます。一覧を、金額が入力した値以上の行だけに絞り込む、といった操作に使います。

構造 ​

項目内容
区分block
親子に block を取る要素
子なし(/> で閉じる)
SqlView の子孫可(For の中は不可)

使い方 ​

  • 未入力のときは NULL です。NULL との大小の比較は実行時エラーになるので、<For> の where では先に null かどうかを判定します(view.<名前> == null || r.price >= view.<名前>)。未入力のときは、すべての行を表示します
  • SQL は実行し直さないので、絞り込めるのは受け取った行(1,000 行まで)だけです。それより多い行から絞り込むときは、数値入力のパラメータを SQL の条件に使います
  • 枠付きの <Parameter> と並べて見た目をそろえるときは、<Card> で包み、タイトルを <Card> の title に書き、<NumberInput> に width="full" を書きます

属性 ​

属性値内容
as(必須)識別子入力した数値を、式で view.<名前> として参照するための名前。同じ名前の要素は、状態を共有します
title文字列
式:文字+式
入力欄の前に表示するタイトル
placeholder文字列
式:文字+式
空のときに入力欄に表示する文字。何を入力するかを書きます(「下限(万円)」など)
default数値最初に入っている数値。未指定時は未入力(NULL)です
min数値
式:単一式
入力できる最小の値。小さい値は、入力欄を離れたときに min になります
max数値
式:単一式
入力できる最大の値。大きい値は、入力欄を離れたときに max になります
widthpx(例:320px)・full
既定:240px
入力欄の幅。full は親の幅いっぱいです(title を書いたときは、タイトルを除いた残りの幅)。親より広い値は、親の幅になります

例 ​

html
<NumberInput as="minSales" title="売上(万円以上)" min="0" width="120px" />
<SqlView id="…" page="…" sql="…">
  <Table>
    <TableRow header>
      <TableCell><Text>店舗</Text></TableCell>
      <TableCell align="end"><Text>売上</Text></TableCell>
    </TableRow>
    <For as="r" where="{{ view.minSales == null || r.sales >= view.minSales * 10000 }}">
      <TableRow>
        <TableCell><Text>{{ r.store }}</Text></TableCell>
        <TableCell align="end"><Text>{{ r.sales }}</Text></TableCell>
      </TableRow>
    </For>
    <Else>
      <TableRow><TableCell colSpan="2"><Text color="muted">{{ view.minSales }} 万円以上の店舗はありません</Text></TableCell></TableRow>
    </Else>
  </Table>
</SqlView>

Slider ​

表示の状態に、閲覧者がスライダーで選んだ数値を持たせます。一覧を、選んだ値以上の行だけに絞り込む、といった操作に使います。

構造 ​

項目内容
区分block
親子に block を取る要素
子なし(/> で閉じる)
SqlView の子孫可(For の中は不可)

使い方 ​

  • 未選択のときは NULL で、取っ手を表示しません。バーを押すと、その位置の値を選びます。NULL との大小の比較は実行時エラーになるので、<For> の where では先に null かどうかを判定します(view.<名前> == null || r.price >= view.<名前>)
  • 未選択に戻すときは、<ViewStateLink> に <ViewStateValue view="<名前>" value="" /> を書きます
  • 同じ as の <NumberInput> と並べると、スライダーで大まかに選び、入力欄で細かく直せます
  • SQL は実行し直さないので、絞り込めるのは受け取った行(1,000 行まで)だけです

属性 ​

属性値内容
as(必須)識別子選んだ数値を、式で view.<名前> として参照するための名前。同じ名前の要素は、状態を共有します
min(必須)数値
式:単一式
スライダーの左端の値。<SqlView> の中では、結果の行の値も書けます(min="{{ row.min_price }}")
max(必須)数値
式:単一式
スライダーの右端の値。<SqlView> の中では、結果の行の値も書けます(max="{{ row.max_price }}")
title文字列
式:文字+式
入力欄の前に表示するタイトル
default数値最初に選んでいる数値。未指定時は未選択(NULL)です
step数値
既定:1
選べる値の刻み。0 より大きい値を書きます
formatd3-format の書式両端とツールチップに出す値の書式("$,.0f"・"{,d}円" など)。未指定時は、閲覧者の言語設定の既定の書式です
widthpx(例:320px)・full
既定:240px
入力欄の幅。full は親の幅いっぱいです(title を書いたときは、タイトルを除いた残りの幅)。親より広い値は、親の幅になります

例 ​

html
<Slider as="minRating" title="評価" min="1" max="5" step="0.5" format=".1f" />
<SqlView id="…" page="…" sql="…">
  <List>
    <For as="r" where="{{ view.minRating == null || r.rating >= view.minRating }}">
      <ListItem><Text>{{ r.store }}({{ r.rating }})</Text></ListItem>
    </For>
  </List>
</SqlView>

RangeSlider ​

表示の状態に、閲覧者がスライダーで選んだ数値の範囲を持たせます。一覧を、価格が選んだ範囲に入る行だけに絞り込む、といった操作に使います。

構造 ​

項目内容
区分block
親子に block を取る要素
子なし(/> で閉じる)
SqlView の子孫可(For の中は不可)

使い方 ​

  • 一覧を絞り込むときは、<For> の where に inRange(列, view.<名前>) を書きます。未選択のときは、すべての行を表示します
  • 未選択のときは NULL で、取っ手を両端に薄く表示します。式で下限と上限を読むときは view.<名前>[0]・view.<名前>[1] で、先に null かどうかを判定します
  • 取っ手を両端まで戻すと、未選択に戻ります。リンクで戻すときは、<ViewStateLink> に <ViewStateValue view="<名前>" value="" /> を書きます
  • min・max を SQL の実行結果から決めるときは、<SqlView> の中に置き、min・max に列の最小値と最大値を書きます(min="{{ min(rows, 'price') }}" max="{{ max(rows, 'price') }}")
  • SQL は実行し直さないので、絞り込めるのは受け取った行(1,000 行まで)だけです

属性 ​

属性値内容
as(必須)識別子選んだ範囲を、式で view.<名前> として参照するための名前。同じ名前の要素は、状態を共有します
min(必須)数値
式:単一式
スライダーの左端の値。<SqlView> の中では、結果の行の値も書けます(min="{{ row.min_price }}")
max(必須)数値
式:単一式
スライダーの右端の値。<SqlView> の中では、結果の行の値も書けます(max="{{ row.max_price }}")
title文字列
式:文字+式
入力欄の前に表示するタイトル
default数値の範囲(例:10,100)最初に選んでいる範囲。下限と上限を , で区切ります(10,100)。未指定時は未選択(NULL)です
step数値
既定:1
選べる値の刻み。0 より大きい値を書きます
formatd3-format の書式両端とツールチップに出す値の書式("$,.0f"・"{,d}円" など)。未指定時は、閲覧者の言語設定の既定の書式です
widthpx(例:320px)・full
既定:240px
入力欄の幅。full は親の幅いっぱいです(title を書いたときは、タイトルを除いた残りの幅)。親より広い値は、親の幅になります

例 ​

html
<SqlView id="…" page="…" sql="…">
  <RangeSlider as="price" title="価格" min="0" max="{{ row.max_price }}" step="10" format="$,.0f" />
  <Table>
    <For as="r" where="{{ inRange(r.price, view.price) }}">
      <TableRow>
        <TableCell><Text>{{ r.name }}</Text></TableCell>
        <TableCell align="end"><Text>{{ r.price }}</Text></TableCell>
      </TableRow>
    </For>
  </Table>
  <Text><ViewStateLink title="価格の条件を外す"><ViewStateValue view="price" value="" /></ViewStateLink></Text>
</SqlView>

パラメータの値を設定するリンクです。クリックすると、子の <ParameterLinkValue> に書いた値をパラメータに設定し、そのパラメータを参照している要素を実行します。一覧から選んだ値で詳しい表示に切り替える(ドリルダウン)、期間のプリセットを選ぶ、条件をリセットする、といった操作に使います。子に <ViewStateValue> を書くと、表示の状態も一緒に設定します。

構造 ​

項目内容
区分inline
親Text | Span
子(ParameterLinkValue | ViewStateValue)+
SqlView の子孫可

使い方 ​

  • リンクの文字は title に書きます。<Link> と違い、子に文字は書けません
  • 次のときは、リンクにならず、title の文字だけが表示されます
    • クリックしても値が変わらないとき(設定する値が、すべて現在の値と同じとき)。scrollTo を書いたときは除きます
    • 子の value が NULL か、パラメータに設定できない値のとき
    • 閲覧者がパラメータを変えられないとき(パラメータを固定した公開など)
  • 表示の状態だけを設定するときは、<ViewStateLink> を使います
  • ドリルダウンは、選んだ値をパラメータに設定し、その値で <If> を書き分けて作ります(例を参照)。まだ選んでいない階層のパラメータは、未設定にしておきます
    • 下の階層のパラメータには、上の階層のパラメータを resetIfChanged に指定します(リセット条件)。上の階層の値が変わると、リンク・入力欄・ページ上部のパラメータフォームのどれで変えたときも、下の階層が順にリセットされます
    • 選択肢を SQL で生成するパラメータは、optionsSourceSqlResetIfDependentChanged: true で、選択肢の SQL が参照するパラメータをまとめてリセット条件に加えられます(クエリ実行結果)。一部のパラメータだけでリセットしたいときは、指定せずに resetIfChanged で個別に選びます
    • リンクには、その階層のパラメータの値だけを書きます。上の階層に戻るリンクは、1 つ下の階層のパラメータを value="" で未設定にします。それより下の階層は、連動でリセットされます
    • リセットするとデフォルト値になり、デフォルト値がなければ未設定になります。そのため、ドリルダウンに使うパラメータにはデフォルト値を設定しません
    • 下の階層の SQL は、上の階層のパラメータが未設定のときにもエラーにならないように書きます(パラメータと実行)
    • リンクに設定する列の値が NULL の行は、リンクになりません。選べるようにするには、SQL で NULL を別の値に置き換えます(COALESCE(category, '(なし)'))。下の階層の SQL の絞り込みでも、同じように置き換えます

属性 ​

属性値内容
title(必須)文字列
式:文字+式
リンクの文字
active真偽値
式:単一式
選択中として強調して表示します
scrollTo英数字・_・-クリックしたあとの移動先の要素の anchor

例 ​

html
<Breadcrumb>
  <BreadcrumbItem>
    <Text><ParameterLink title="すべて"><ParameterLinkValue param="6aed7dd1bd9a064614d5985b" value="" /></ParameterLink></Text>
  </BreadcrumbItem>
  <If condition="{{ param_6aed7dd1bd9a064614d5985b != '' }}">
    <BreadcrumbItem>
      <Text>{{ param_6aed7dd1bd9a064614d5985b }}</Text>
    </BreadcrumbItem>
  </If>
</Breadcrumb>
<If condition="{{ param_6aed7dd1bd9a064614d5985b == '' }}">
  <!-- カテゴリ別の売上。カテゴリをクリックすると、パラメータに設定される -->
  <SqlView id="…" page="…" sql="…">
    <List>
      <For as="r">
        <ListItem>
          <Text><ParameterLink title="{{ r.category }}"><ParameterLinkValue param="6aed7dd1bd9a064614d5985b" value="{{ r.category }}" /></ParameterLink> {{ formatNumber(r.sales) }}</Text>
        </ListItem>
      </For>
    </List>
  </SqlView>
</If>
<Else>
  <!-- 選んだカテゴリの、サブカテゴリ別の売上。SQL でパラメータを参照して絞り込む -->
  <SqlResult id="…" page="…" sql="…" />
</Else>

ParameterLinkValue ​

<ParameterLink> をクリックしたときに、1 つのパラメータに設定する値です。

構造 ​

項目内容
区分―
親ParameterLink
子なし(/> で閉じる)
SqlView の子孫可

使い方 ​

値の書き方は、パラメータの種類で決まります。式で書いた値は、型が変換されません。型が合わないときは、SQL で型を変換した列を用意します。

パラメータの種類固定の値式の値
テキスト入力・テキスト選択書いたとおりの文字文字列
テキスト複数入力・テキスト複数選択, 区切り(JP,US)文字列のリスト
数値入力・数値選択数値数値
日付入力YYYY-MM-DDYYYY-MM-DD の文字列
日付範囲開始日と終了日を , 区切り(2026-01-01,2026-01-31)[開始日, 終了日] のリスト
チェックボックスtrue・false真偽値
  • 日付範囲を式で書くときは、{{ [r.start_date, r.end_date] }} のようにリストにします。{{ r.start_date }},{{ r.end_date }} とは書けません
  • 単位(週・月・年)を設定した日付のパラメータでは、入力欄で選んだときと同じく、単位の始まりか終わりの日にそろえて設定します
  • 次の値は設定できません
    • 選択肢をテキストで定義したパラメータに、選択肢にない値
    • 数値入力に、範囲(最小値・最大値)の外の値
  • 選択肢を SQL やテーブルから動的に生成するパラメータでは、選択肢にない値かどうかを検査しません

属性 ​

属性値内容
param(必須)ObjectId設定するパラメータの ID
valueパラメータの値(使い方を参照)
式:単一式
設定する値。"" を書くと未設定になります。未指定時は、デフォルト値になります

表示の状態を設定するリンクです。クリックすると、子の <ViewStateValue> に書いた値を表示の状態(as で名前を付けた <Select>・<Switch>・<TextInput>・<NumberInput>・<Slider>・<RangeSlider>・<Tabs>・<Collapse>)に設定します。複数の <Collapse> をまとめて開く・閉じる、<Select>・<Switch> で切り替える表示を文の中から切り替える、といった操作に使います。

構造 ​

項目内容
区分inline
親Text | Span
子ViewStateValue+
SqlView の子孫可

使い方 ​

  • リンクの文字は title に書きます。<Link> と違い、子に文字は書けません
  • SQL は実行しません。閲覧者がパラメータを変えられないとき(パラメータを固定した公開など)も、クリックできます
  • 次のときは、リンクにならず、title の文字だけが表示されます
    • クリックしても値が変わらないとき(設定する値が、すべて現在の値と同じとき)。scrollTo を書いたときは除きます
    • 子の value が NULL か、表示の状態に設定できない値のとき
  • 切り替えた要素が画面の外にあるとき(モバイル表示で <Columns> が縦に並ぶときなど)は、scrollTo に移動先を書きます(リンクの移動先)
  • 移動先を含むタブに切り替える、閉じた <Collapse> を開くだけなら、<Link> の scrollTo でもできます
  • パラメータも一緒に設定するときは、<ParameterLink> の子に <ViewStateValue> を書きます

属性 ​

属性値内容
title(必須)文字列
式:文字+式
リンクの文字
active真偽値
式:単一式
選択中として強調して表示します
scrollTo英数字・_・-クリックしたあとの移動先の要素の anchor

例 ​

html
<Text>
  <ViewStateLink title="すべて開く"><ViewStateValue view="defSales" value="true" /><ViewStateValue view="defOrders" value="true" /></ViewStateLink>・<ViewStateLink title="すべて閉じる"><ViewStateValue view="defSales" value="false" /><ViewStateValue view="defOrders" value="false" /></ViewStateLink>
</Text>
<Collapse title="売上" as="defSales"><Text>…</Text></Collapse>
<Collapse title="注文数" as="defOrders"><Text>…</Text></Collapse>

ViewStateValue ​

<ParameterLink>・<ViewStateLink> をクリックしたときに、1 つの表示の状態に設定する値です。

構造 ​

項目内容
区分―
親ParameterLink | ViewStateLink
子なし(/> で閉じる)
SqlView の子孫可

使い方 ​

  • value="{{ !view.detailOpen }}" と書くと、クリックするたびに <Collapse> の開閉を切り替えるリンクになります

属性 ​

属性値内容
view(必須)識別子設定する表示の状態の名前(as で付けた名前)
value表示の状態の値(要素ごとの値は内容を参照)
式:単一式
設定する値。<Select>・<Tabs> は選択肢の value、<Switch>・<Collapse> は true か false、<TextInput> は任意の文字、<NumberInput>・<Slider> は数値、<RangeSlider> は下限と上限を , で区切った値(10,100)。空の値(value="")を書くと、<TextInput> は空の文字に、数値と範囲は未入力に戻ります。未指定時は、既定の状態になります

Paginator ​

<SqlView> の中で、囲んだ <For> の繰り返しを一覧のページに分け、ページネーションを表示します。一覧のページを切り替えても、SQL は実行されません。

構造 ​

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

使い方 ​

  • 中に <For> を 1 つ書き、その繰り返しをページに分けます
    • 並べ替えと絞り込みは、その <For> の orderBy・where に書きます
    • index は、ページをまたいだ通し番号になります
  • ページに分けられるのは、<SqlView> が受け取った行(1,000 行まで)です。1,000 行を超える一覧には、<ParameterPaginator> を使います
  • 表示している一覧のページは、閲覧者ごとの表示の状態で、保存や共有はされません
    • SQL を実行し直したときと、絞り込みや並べ替えで一覧が変わったときは、1 ページ目に戻ります
    • PDF とスクリーンショットでは、1 ページ目が表示されます
  • <For> の中にも書けます。繰り返しの 1 回ごとにページネーションが表示され、それぞれ別にページを切り替えられます
    • 例:グループごとのカードの中で、そのグループの明細をページに分けて表示する

属性 ​

属性値内容
pageSize整数(1〜1000)
既定:20
1 ページの件数
positiontop / bottom / both
既定:bottom
ページネーションを表示する位置。top は一覧の上、bottom は下、both は上と下の両方

例 ​

html
<Select as="sort" variant="segmented">
  <SelectOption value="sales" title="売上順" default />
  <SelectOption value="mom" title="伸び率順" />
</Select>
<SqlView id="…" page="…" sql="…">
  <Paginator pageSize="20">
    <Table>
      <TableRow header>
        <TableCell><Text>順位</Text></TableCell>
        <TableCell><Text>店舗</Text></TableCell>
        <TableCell><Text>売上</Text></TableCell>
      </TableRow>
      <For as="r" index="i" orderBy="{{ view.sort == 'mom' ? r.mom : r.sales }}" desc>
        <TableRow>
          <TableCell><Text>{{ i }}</Text></TableCell>
          <TableCell><Text>{{ r.name }}</Text></TableCell>
          <TableCell><Text>{{ formatNumber(r.sales) }}</Text></TableCell>
        </TableRow>
      </For>
    </Table>
  </Paginator>
</SqlView>

ParameterPaginator ​

<SqlView> の中にページネーションを表示し、1,000 行を超える一覧を SQL で 1 ページずつ取得します。一覧のページを切り替えると、パラメータに offset(先頭から飛ばす件数)が設定され、そのパラメータを参照している要素が実行されます。

構造 ​

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

使い方 ​

  • SQL には、ORDER BY・LIMIT・OFFSET を書きます(プレースホルダと参照)
    • OFFSET:offset のパラメータのプレースホルダ($1 など)
    • LIMIT:pageSize と同じ数
    • ORDER BY:並べ替える列の最後に、ID などの一意な列を加えます(ORDER BY ordered_at DESC, order_id など)。値が同じ行の順は実行のたびに変わることがあり、そのままではページの間で行が重複したり、抜けたりするためです
  • offset のパラメータに、絞り込みのパラメータをリセット条件(resetIfChanged)として指定すると、絞り込みを変えたときに 1 ページ目へ戻ります(リセット条件)
  • 囲んだ <For> には、where・orderBy・desc・limit を書けません。並べ替えと絞り込みは SQL で行います
  • index は、offset から数えた、ページをまたいだ通し番号になります。<Group> のグループを繰り返す <For> では、ページごとに 1 から振られます
  • offset のパラメータは、ほかのパラメータと同じく、ページ上部のパラメータフォームにも表示されます。閲覧者がパラメータを変えられないとき(パラメータを固定した公開など)は、一覧のページを切り替えられません

属性 ​

属性値内容
param(必須)ObjectIdoffset(先頭から飛ばす件数)を設定するパラメータの ID。種類が数値入力で、最小値を 0 にし、最大値を設定せず、デフォルト値を未設定か 0 にしたパラメータを指定します(数値入力)
pageSize(必須)整数(1〜1000)1 ページの件数。SQL の LIMIT と同じ数にします
total文字列全体の件数を入れた列の名前。件数は SQL の COUNT(*) OVER () などで求めます。最初の行の値を使います。未指定時は、ページ番号と全体の件数を表示せず、前のページと次のページへのボタンだけを表示します。件数が pageSize で割り切れるときは、最後のページでも次のページへのボタンが有効になり、押すと空の一覧が表示されます
positiontop / bottom / both
既定:bottom
ページネーションを表示する位置。top は一覧の上、bottom は下、both は上と下の両方

例 ​

html
<!-- SQL:SELECT …, COUNT(*) OVER () AS total FROM orders ORDER BY ordered_at DESC, order_id LIMIT 50 OFFSET $1($1 は offset のパラメータ) -->
<SqlView id="…" page="…" sql="…">
  <ParameterPaginator param="6aed7dd1bd9a064614d5985c" pageSize="50" total="total">
    <Table>
      <TableRow header>
        <TableCell><Text>No.</Text></TableCell>
        <TableCell><Text>注文番号</Text></TableCell>
        <TableCell><Text>金額</Text></TableCell>
      </TableRow>
      <For as="r" index="i">
        <TableRow>
          <TableCell><Text>{{ i }}</Text></TableCell>
          <TableCell><Text>{{ r.order_id }}</Text></TableCell>
          <TableCell><Text>{{ formatNumber(r.amount) }}</Text></TableCell>
        </TableRow>
      </For>
    </Table>
  </ParameterPaginator>
</SqlView>

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