これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.create
メソッドおよびdashboard.update
メソッドでマップウィジェットを設定できます。
ウィジェットのfields
プロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 マップウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
マップウィジェットでは、以下のパラメーターがサポートされています。
パラメータ | type | name | value | |
---|---|---|---|---|
リフレッシュ間隔 | 0 | rf_rate | 0 - 更新なし 10 - 10秒 30 - 30秒 60 - 1分 120 - 2分 600 - 10分 900 - (デフォルト) 15分 |
|
マップ | 8 | sysmapid.0 | マップID。 パラメーターの動作: - マップ(ウィジェット)が設定されていない場合、必須 |
|
マップ(ウィジェット) | 1 | sysmapid._reference | ABCDE._mapid - マップのデータソースとして、マップナビゲーションウィジェット(参照パラメーターが"ABCDE "に設定されている)を設定します。パラメーターの動作: - マップが設定されていない場合、必須 |
|
参照 | 1 | reference | 5文字からなる任意の文字列値(例: ABCDE やJBPNL )。この値は、ウィジェットが属するダッシュボード内で一意である必要があります。パラメーターの動作: - 必須 |
次の例は、マップウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.create
を参照してください。
マップ"1"を表示するマップウィジェットを設定します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "map",
"name": "Map",
"x": 0,
"y": 0,
"width": 54,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 8,
"name": "sysmapid.0",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
レスポンス:
マップナビゲーションウィジェットにリンクされたマップウィジェットを設定します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "map",
"name": "Map",
"x": 0,
"y": 5,
"width": 54,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "sysmapid._reference",
"value": "ABCDE._mapid"
}
]
},
{
"type": "navtree",
"name": "Map navigation tree",
"x": 0,
"y": 0,
"width": 18,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "navtree.1.name",
"value": "Element A"
},
{
"type": 1,
"name": "navtree.2.name",
"value": "Element B"
},
{
"type": 1,
"name": "navtree.3.name",
"value": "Element C"
},
{
"type": 1,
"name": "navtree.4.name",
"value": "Element A1"
},
{
"type": 1,
"name": "navtree.5.name",
"value": "Element A2"
},
{
"type": 1,
"name": "navtree.6.name",
"value": "Element B1"
},
{
"type": 1,
"name": "navtree.7.name",
"value": "Element B2"
},
{
"type": 0,
"name": "navtree.4.parent",
"value": 1
},
{
"type": 0,
"name": "navtree.5.parent",
"value": 1
},
{
"type": 0,
"name": "navtree.6.parent",
"value": 2
},
{
"type": 0,
"name": "navtree.7.parent",
"value": 2
},
{
"type": 0,
"name": "navtree.1.order",
"value": 1
},
{
"type": 0,
"name": "navtree.2.order",
"value": 2
},
{
"type": 0,
"name": "navtree.3.order",
"value": 3
},
{
"type": 0,
"name": "navtree.4.order",
"value": 1
},
{
"type": 0,
"name": "navtree.5.order",
"value": 2
},
{
"type": 0,
"name": "navtree.6.order",
"value": 1
},
{
"type": 0,
"name": "navtree.7.order",
"value": 2
},
{
"type": 8,
"name": "navtree.6.sysmapid",
"value": 1
},
{
"type": 1,
"name": "reference",
"value": "ABCDE"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
レスポンス: