7 Geomap
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドで地理マップウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 地理マップウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
パラメータ
Geomapウィジェットでサポートされているパラメータは以下の通りです。
| パラメータ | type | name | 値 | |
|---|---|---|---|---|
| 更新間隔 | 0 | rf_rate | 0 - 更新なし; 10 - 10秒; 30 - 30秒; 60 - (デフォルト) 1分; 120 - 2分; 600 - 10分; 900 - 15分。 |
|
| ホストグループ | 2 | groupids.0 | ホストグループのID。 注: 複数のホストグループを設定するには、各ホストグループごとにプロパティ名の番号を増やしてダッシュボードウィジェットフィールドオブジェクトを作成してください。 このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| ホストグループ(ウィジェット) | 1 | groupids._reference | ホストグループのIDの代わりに:ABCDE._hostgroupids - Referenceパラメータを"ABCDE"に設定した互換性のあるウィジェットをホストグループのデータソースとして設定します。このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| ホスト | 3 | hostids.0 | ホストのID。 注: 複数のホストを設定するには、各ホストごとにプロパティ名の番号を増やしてダッシュボードウィジェットフィールドオブジェクトを作成してください。複数のホストを指定する場合、ホストグループパラメータは未設定、または指定したホストが属するホストグループを少なくとも1つ設定する必要があります。 このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| ホスト(ウィジェット/ダッシュボード) | 1 | hostids._reference | ホストのIDの代わりに:DASHBOARD.hostids - ダッシュボードのホストセレクタをホストのデータソースとして設定します;ABCDE._hostids - Referenceパラメータを"ABCDE"に設定した互換性のあるウィジェットをホストのデータソースとして設定します。このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| タグ | ||||
| 評価タイプ | 0 | evaltype | 0 - (デフォルト) And/Or; 2 - Or。 このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| タグ名 | 1 | tags.0.tag | 任意の文字列値。 注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。 パラメータの動作: - 必須 (Tagsを設定する場合) このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| 演算子 | 0 | tags.0.operator | 0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない。 注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。 パラメータの動作: - 必須 (Tagsを設定する場合) このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| タグ値 | 1 | tags.0.value | 任意の文字列値。 注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。 パラメータの動作: - 必須 (Tagsを設定する場合) このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| 初期表示 | 1 | default_view | カンマ区切りの緯度、経度、ズームレベル（省略可能、0-30の範囲）。 例: 40.6892494,-74.0466891,10。 |
|
| クラスタリング | ||||
| クラスタリングモード | 0 | clustering_mode | 0 - (デフォルト) 自動; 1 - ズームレベル。 |
|
| クラスタリングズームレベル | 0 | clustering_zoom_level | 0-30の範囲。 デフォルト: 0。 パラメータの動作: - サポート (Clustering modeが"Zoom level"の場合) |
|
| Reference | 1 | reference | 5文字からなる任意の文字列値（例: ABCDEやJBPNL）。この値は、ウィジェットが属するダッシュボード内で一意でなければなりません。パラメータの動作: - 必須 |
|
例
次の例は、地理マップウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
地理マップウィジェットの設定
以下のタグ設定に基づいて、ホストグループ"2"と"22"のホストを表示する地理マップウィジェットを設定します。 "component"という名前のタグに"node"という値が含まれる、または"location"という名前のタグに"New York"という値と等しいもの。 さらに、マップの初期表示を座標"40.6892494"(緯度)、"-74.0466891"(経度)、ズームレベル"10"に設定します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "geomap",
"name": "Geomap",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 22
},
{
"type": 2,
"name": "groupids.1",
"value": 2
},
{
"type": 1,
"name": "default_view",
"value": "40.6892494,-74.0466891,10"
},
{
"type": 0,
"name": "evaltype",
"value": 2
},
{
"type": 1,
"name": "tags.0.tag",
"value": "component"
},
{
"type": 0,
"name": "tags.0.operator",
"value": 0
},
{
"type": 1,
"name": "tags.0.value",
"value": "node"
},
{
"type": 1,
"name": "tags.1.tag",
"value": "location"
},
{
"type": 0,
"name": "tags.1.operator",
"value": 1
},
{
"type": 1,
"name": "tags.1.value",
"value": "New York"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス: