このページで
10 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または、FromおよびToパラメーターで期間のみを設定することもできます。 |
|
| From | 1 | time_period.from | 絶対（YYYY-MM-DD hh:mm:ss）または相対時間構文（now、now/d、now/w-1wなど）での有効な時間文字列。パラメーターの動作: - 期間が設定されていない場合はサポート - time_period.toが設定されている場合は必須 |
|
| 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
}