Documentation
Table of Contents
> Template dashboardオブジェクト
次のオブジェクトは、templatedashboardAPIに直接関連しています。
Template dashboard
template dashboardオブジェクトには次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| dashboardid | string | (読取専用) テンプレートダッシュボードのID |
| name (必須) |
string | テンプレートダッシュボード名 |
| templateid (必須) |
string | ダッシュボードが属するテンプレートの ID |
| display_period | integer | デフォルトのページ表示期間 (秒単位) 有効な値: 10,30,60,120,600,1800,3600 デフォルト: 30 |
| auto_start | integer | スライドショーの自動開始 有効な値: 0 - しない 1 - (デフォルト)する |
| uuid | string | インポートされたテンプレート ダッシュボードを既存のものにリンクするために使用されるユニバーサル一意識別子。 指定されていない場合は自動生成されます。 更新操作の場合このフィールドは 読取専用 です。 |
Template dashboard page
template dashboard pageオブジェクトには次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| dashboard_pageid | string | (読取専用) ダッシュボードページのID |
| name | string | ダッシュボードページ名 デフォルト: 空の文字列 |
| display_period | integer | ダッシュボード ページの表示期間 (秒単位) 有効な値: 0,10,30,60,120,600,1800,3600 デフォルト: 0 |
| widgets | array | テンプレート ダッシュボード ウィジェットオブジェクトの配列 |
Template dashboard widget
template dashboard widget オブジェクトには次のプロパティがあります
| プロパティ | タイプ | 説明 |
|---|---|---|
| widgetid | string | (読取専用) ダッシュボードウィジェットのID |
| type (必須) |
string | ダッシュボード ウィジェットのタイプ 利用可能な値: clock - クロック graph - グラフ (クラシック) graphprototype - グラフ プロトタイプ item - アイテム値<br >plaintext - プレーン テキスト url - URL |
| name | string | カスタムウィジェット名 |
| x | integer | ダッシュボードの左側からの水平位置。 有効な値の範囲は 0 から 23 です。 |
| y | integer | ダッシュボードの上部からの垂直位置。 有効な値の範囲は 0 ～ 62 です。 |
| width | integer | ウィジェットの幅。 有効な値の範囲は 1 ～ 24 です。 |
| height | integer | ウィジェットの高さ。 有効な値の範囲は 2 から 32 です。 |
| view_mode | integer | ウィジェット ビュー モード 有効な値: 0 - (デフォルト) デフォルトのウィジェットビュー 1 - ヘッダー非表示 |
| fields | array | テンプレート ダッシュボード ウィジェット フィールド オブジェクトの配列。 |
Template dashboard widget field
template dashboard widget fieldオブジェクトには次のプロパティがあります
| プロパティ | タイプ | 説明 |
|---|---|---|
| type (必須) |
integer | ウィジェット フィールドのタイプ 使用可能な値: 0 - 整数 1 - 文字列 4 - アイテム 5 - アイテム プロトタイプ 6 - グラフ 7 - グラフのプロトタイプ |
| name | string | ウィジェットフィールド名 |
| value (必須) |
mixed | タイプに応じたウィジェット フィールドの値 |