このページで
11 Graph prototype
説明
これらのパラメータおよび各ダッシュボードウィジェットフィールドオブジェクトに対応する使用可能なプロパティ値により、dashboard.create および dashboard.update メソッドで グラフプロトタイプ ウィジェットを設定できます。
ダッシュボードの作成または更新時に、ウィジェットの fields プロパティは検証されません。
これにより、ユーザーは 組み込みウィジェット を変更したり、カスタムウィジェット を作成したりできますが、その一方で、ウィジェットを誤って作成または更新してしまうリスクも生じます。
グラフプロトタイプ ウィジェットの作成または更新を正常に行うため、以下の表に示すパラメータの動作を参照してください。
パラメータ
以下のパラメータは、グラフプロトタイプウィジェットでサポートされています。
| パラメータ | type | name | value | |
|---|---|---|---|---|
| 更新間隔 | 0 | rf_rate | 0 - 更新なし; 10 - 10秒; 30 - 30秒; 60 - (デフォルト) 1分; 120 - 2分; 600 - 10分; 900 - 15分。 |
|
| ソース | 0 | source_type | 2 - (デフォルト) グラフプロトタイプ; 3 - シンプルグラフプロトタイプ。 |
|
| グラフプロトタイプ | 7 | graphid.0 | グラフプロトタイプ ID。 パラメータの動作: - ソースが「グラフプロトタイプ」に設定されている場合は必須 |
|
| アイテムプロトタイプ | 5 | itemid.0 | アイテムプロトタイプ ID。 パラメータの動作: - ソースが「シンプルグラフプロトタイプ」に設定されている場合は必須 |
|
| 期間 | 1 | time_period._reference | DASHBOARD._timeperiod - 期間セレクターをデータソースとして設定します;ABCDE._timeperiod - 互換性のあるウィジェット（参照パラメータが「ABCDE」に設定されているもの）をデータソースとして設定します。デフォルト: DASHBOARD._timeperiodまたは、開始および終了パラメータでのみ期間を設定することもできます。 |
|
| 開始 | 1 | time_period.from | 絶対時間（YYYY-MM-DD hh:mm:ss）または相対時間構文（now、now/d、now/w-1w など）の有効な時間文字列。パラメータの動作: - 期間が設定されていない場合にサポート - time_period.to が設定されている場合は必須 |
|
| 終了 | 1 | time_period.to | 絶対時間（YYYY-MM-DD hh:mm:ss）または相対時間構文（now、now/d、now/w-1w など）の有効な時間文字列。パラメータの動作: - 期間が設定されていない場合にサポート - time_period.from が設定されている場合は必須 |
|
| 凡例の表示 | 0 | show_legend | 0 - 無効; 1 - (デフォルト) 有効。 |
|
| ホストの上書き | 1 | override_hostid._reference | ABCDE._hostid - 互換性のあるウィジェット（参照パラメータが「ABCDE」に設定されているもの）をホストのデータソースとして設定します;DASHBOARD._hostid - ダッシュボードのホストセレクターをホストのデータソースとして設定します。このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| 列数 | 0 | columns | 指定可能な値は 1～24 です。 デフォルト: 2。 |
|
| 行数 | 0 | rows | 指定可能な値は 1～16 です。 デフォルト: 1。 |
|
| 参照 | 1 | reference | 5文字で構成される任意の文字列値（例: ABCDE または JBPNL）。この値は、ウィジェットが属するダッシュボード内で一意である必要があります。パラメータの動作: - 必須 |
|
例
次の例は、グラフのプロトタイプウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。
ダッシュボードの設定の詳細については、dashboard.createを参照してください。
グラフのプロトタイプウィジェットの設定
ローレベルディスカバリによってアイテムのプロトタイプ(ID: "42316")から作成された3つのグラフ(3列、1行)のグリッドを表示するグラフのプロトタイプウィジェットを設定します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "graphprototype",
"name": "Graph prototype",
"x": 0,
"y": 0,
"width": 48,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "source_type",
"value": 3
},
{
"type": 5,
"name": "itemid.0",
"value": 42316
},
{
"type": 0,
"name": "columns",
"value": 3
},
{
"type": 1,
"name": "reference",
"value": "OPQWX"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}