マークアップページ

INFO

マークアップページはプライベートプレビューの機能です。機能が有効なワークスペースでのみ利用できます。また、仕様は予告なく変更される場合があります。

機能が有効かどうかは、cdm auth whoami で確認できます。マークアップページを扱うには、CLI のバージョン 0.46.0 以降が必要です。古い場合は、cdm update で更新してください。

概要

マークアップページは、ドキュメントページで定義したチャートや SQL ブロックの実行結果、パラメータの入力欄、見出しや説明文を、タグで並べてダッシュボードを作るページです
配置と大きさもタグの入れ子で書くため、ページ全体を 1 つのテキストとして読み書きできます
ページは、yaml {.page} のページ属性と、html {.markup} のコードブロックに書くコードからなります

このページでは、ノートブックファイルでの書き方を説明します。コードの書き方は記法を、要素と属性は要素一覧を、式の関数と書式は式を参照してください。

ページ属性

id は、ノートブックファイル内でユニークな値にします。指定しない場合は、cdm notebook format で付与されます
width はページ幅です。既定値は { width_type: 'AUTO' }（画面幅に合わせて伸縮）で、既定値のときは出力されません
パラメータはパラメータを参照してください

type MarkupPageAttrs = {
  type: 'MARKUP_PAGE';
  id: ObjectId;
  width?:
    | { width_type: 'AUTO' }
    | { width_type: 'FIXED'; fixed_width: 640 | 800 | 1024 | 1280 | 1366 | 1600 }
    | {
        width_type: 'RANGE';
        min_width?: 640 | 800 | 1024 | 1280 | 1366 | 1600;
        max_width?: 640 | 800 | 1024 | 1280 | 1366 | 1600;
      };

  // パラメータの説明を参照
  notebook_param_widget_values?: ParamWidgetValue[];
  page_param_widgets?: ParamWidget[];
  page_param_widget_values?: ParamWidgetValue[];
};

コード

ページ属性に続けて、html {.markup} のコードブロックを 1 つだけ書きます。コードブロックの外には、ほかの内容を書けません
- 言語名の html は、エディタで色分けするための指定です。HTML のタグや CSS は書けません
- コードブロックがないときは、cdm notebook format で空のコードブロックが挿入されます
Web版で編集したコードは、整形されずに出力されます。cdm notebook format と cdm notebook run で整形されます
Web版では、コードに構文エラーがあっても保存できます。構文エラーのあるマークアップページが 1 つでもあると、そのノートブックの cdm notebook push・diff・run などはエラーになります
- 先に cdm notebook validate で誤りを確認し、修正してください

例

# 月次の売上

```yaml {.page}
type: MARKUP_PAGE
id: 69dac8455174dcb50b75e100
```

```html {.markup}
<Heading id="69dac8455174dcb50b75e101" level="2">月次の売上</Heading>
<Columns>
  <Parameter
    param="69dac8455174dcb50b75e090"
    scope="NOTEBOOK"
    autoRun
  />
  <Chart
    id="69dac8455174dcb50b75e103"
    page="66a75e5c3a1402e7954373ca"
    chart="69cafa6c871431229e5a3fe1"
  />
</Columns>
```

ドキュメントページとパラメータの参照

マークアップページでは、SQL ブロックやチャートを定義しません。ドキュメントページで定義したものとパラメータを、次の属性に id を書いて参照します。チャートや SQL の内容は、参照先のドキュメントページで編集します。

要素	属性	参照するもの
`Chart`	`page`・`chart`	ドキュメントページ・チャート
`SqlResult`・`SqlView`	`page`・`sql`	ドキュメントページ・SQL ブロック
`Parameter`	`param`	パラメータ
`ParameterOverride`	`param`・`from`・`page`	パラメータ・ドキュメントページ
式	`param_<ID>`	パラメータ

参照先が存在しないときは、エラーになります
Web版では、ほかのページの編集で参照先がなくなっても保存できます。その要素の代わりに、エラーメッセージが表示されます

実行結果と画像の属性

ノートブックファイルでは、実行結果と画像の情報が、要素の開始タグの末尾に属性として付きます。Web版のコードには含まれません。

要素	属性
`Chart`	`jobId`・`state`・`errorMessage`・`chartJobId`・`chartJobQueryHash`
`SqlResult`・`SqlView`	`jobId`・`state`・`errorMessage`
`Image`	`path`・`uploadKey`・`state`・`errorMessage`

これらの属性はコマンドで更新されます。手で書き換えたり、新しい要素に付けたりする必要はありません
属性のない要素では、cdm notebook push してもサーバの実行結果と画像が保持されます
push すると、サーバの実行結果と画像の情報が、ファイルの属性の値で上書きされます。あわせて、パラメータの値（最後に実行したときの値）も、ファイルの値に書き換えられます。--ignore-job-metadata を指定すると、実行結果とパラメータの値は、サーバの値のまま残ります
コードから消えた id の実行結果と画像は、push で削除されます
画像のアップロードは、Web版で行います

マークアップページ ​

概要 ​

ページ属性 ​

コード ​

例 ​

ドキュメントページとパラメータの参照 ​

実行結果と画像の属性 ​

マークアップページ

概要

ページ属性

コード

例

ドキュメントページとパラメータの参照

実行結果と画像の属性