このページで
10 Graph prototype
説明
これらのパラメータと、対応するダッシュボードウィジェットフィールドオブジェクトの可能なプロパティ値により、dashboard.createおよびdashboard.updateメソッドでグラフのプロトタイプウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。
これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新するリスクも生じます。
グラフのプロトタイプウィジェットの作成または更新を確実に行うには、以下の表に記載されているパラメータの動作を参照してください。
パラメータ
以下のパラメータは、Graph prototype ウィジェットでサポートされています。
| Parameter | type | name | value | |
|---|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - 更新しない; 10 - 10秒; 30 - 30秒; 60 - (default) 1分; 120 - 2分; 600 - 10分; 900 - 15分。 |
|
| Source | 0 | source_type | 2 - (default) Graph prototype; 3 - Simple graph prototype. |
|
| Graph prototype | 7 | graphid.0 | Graph prototype のID。 Parameter behavior: - required if Source is set to "Graph prototype" |
|
| Item prototype | 5 | itemid.0 | Item prototype のID。 Parameter behavior: - required if Source is set to "Simple graph prototype" |
|
| Time period | 1 | time_period._reference | DASHBOARD._timeperiod - Time period セレクター をデータソースとして設定します;ABCDE._timeperiod - 互換性のあるウィジェット（Reference パラメータが "ABCDE" に設定されているもの）をデータソースとして設定します。Default: DASHBOARD._timeperiodまた、時間範囲は From と To パラメータのみで設定することもできます。 |
|
| From | 1 | time_period.from | 絶対時間形式 (YYYY-MM-DD hh:mm:ss) または 相対 時間構文 (now, now/d, now/w-1w, など) の有効な時間文字列。Parameter behavior: - supported if Time period is not set - required if time_period.to is set |
|
| To | 1 | time_period.to | 絶対時間形式 (YYYY-MM-DD hh:mm:ss) または 相対 時間構文 (now, now/d, now/w-1w, など) の有効な時間文字列。Parameter behavior: - supported if Time period is not set - required if time_period.from is set |
|
| Show legend | 0 | show_legend | 0 - 無効; 1 - (default) 有効。 |
|
| Override host | 1 | override_hostid._reference | ABCDE._hostid - 互換性のあるウィジェット（Reference パラメータが "ABCDE" に設定されているもの）をホストのデータソースとして設定します;DASHBOARD._hostid - ダッシュボードの Host セレクター をホストのデータソースとして設定します。このパラメータは、テンプレートダッシュボード 上でウィジェットを設定する場合はサポートされません。 |
|
| Columns | 0 | columns | 1-24 の範囲の値を指定できます。 Default: 2. |
|
| Rows | 0 | rows | 1-16 の範囲の値を指定できます。 Default: 1. |
|
| Reference | 1 | reference | 5文字からなる任意の文字列値（例: ABCDE または JBPNL）。この値は、ウィジェットが属するダッシュボード内で一意である必要があります。Parameter behavior: - required |
|
例
次の例は、グラフのプロトタイプウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。
ダッシュボードの設定の詳細については、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
}