Documentation
Table of Contents
14 Map navigation tree
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでマップナビゲーションウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 マップナビゲーションウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーター要件を参照してください。
Parameters
マップナビゲーションツリーウィジェットでは、以下のパラメータがサポートされています。
| パラメータ | type | name | value |
|---|---|---|---|
| 更新間隔 | 0 | rf_rate | 0 - 更新なし; 10 - 10秒; 30 - 30秒; 60 - 1分; 120 - 2分; 600 - 10分; 900 - (デフォルト) 15分 |
| 利用できないマップを表示 | 1 | show_unavailable | 0 - (デフォルト) 無効; 1 - 有効 |
| Reference | 1 | reference | 5文字の任意の文字列値（例：ABCDE、JBPNLなど）パラメータReferenceの値は、Mapウィジェット（Linked widget reference）でMap navigation treeウィジェットとのリンクに使用されます。 |
マップナビゲーションツリー要素の設定には、以下のパラメータがサポートされています。
| Parameter | type | name | value |
|---|---|---|---|
| Name | 1 | navtree.name.1 | 任意の文字列値 注：プロパティ名に含まれる数字は要素番号を設定します。 |
| リンクされたマップ | 8 | navtree.sysmapid.1 | マップ ID 注: プロパティ名の数字は、マップがリンクされている要素を参照します。 |
| 要素階層を作成するためのパラメーター | 0 | navtree.parent.1 | 親要素番号 注: プロパティ名の数字は子要素を参照します。プロパティ値は親要素を参照します。 |
| 0 | navtree.order.1 | マップナビゲーションツリー内の要素の位置 注: プロパティ名の数字は要素番号を参照します。プロパティ値はマップナビゲーションツリー内の要素の位置を参照します。親要素の位置は、マップナビゲーションツリー全体内で決定されます。子要素の位置は、親要素内で決定されます。 |
例
次の例は、マップナビゲーションウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
マップナビゲーションウィジェットの設定
以下のマップナビゲーションツリーを表示するマップナビゲーションウィジェットを設定します:
- 要素A
- 要素A1
- 要素A2
- 要素B
- 要素B1 (リンクされたマップウィジェットに表示できるリンクされたマップ"1"を含む)
- 要素B2
- 要素C
リクエスト:
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "navtree",
"name": "Map navigation tree",
"x": 0,
"y": 0,
"width": 6,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "navtree.name.1",
"value": "Element A"
},
{
"type": 1,
"name": "navtree.name.2",
"value": "Element B"
},
{
"type": 1,
"name": "navtree.name.3",
"value": "Element C"
},
{
"type": 1,
"name": "navtree.name.4",
"value": "Element A1"
},
{
"type": 1,
"name": "navtree.name.5",
"value": "Element A2"
},
{
"type": 1,
"name": "navtree.name.6",
"value": "Element B1"
},
{
"type": 1,
"name": "navtree.name.7",
"value": "Element B2"
},
{
"type": 0,
"name": "navtree.parent.4",
"value": 1
},
{
"type": 0,
"name": "navtree.parent.5",
"value": 1
},
{
"type": 0,
"name": "navtree.parent.6",
"value": 2
},
{
"type": 0,
"name": "navtree.parent.7",
"value": 2
},
{
"type": 0,
"name": "navtree.order.1",
"value": 1
},
{
"type": 0,
"name": "navtree.order.2",
"value": 2
},
{
"type": 0,
"name": "navtree.order.3",
"value": 3
},
{
"type": 0,
"name": "navtree.order.4",
"value": 1
},
{
"type": 0,
"name": "navtree.order.5",
"value": 2
},
{
"type": 0,
"name": "navtree.order.6",
"value": 1
},
{
"type": 0,
"name": "navtree.order.7",
"value": 2
},
{
"type": 8,
"name": "navtree.sysmapid.6",
"value": 1
},
{
"type": 1,
"name": "reference",
"value": "ABCDE"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}レスポンス: