This is a translation of the original English documentation page. Help us make it better.

19 Map navigation tree

説明

これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでマップナビゲーションウィジェットを設定できます。

ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 マップナビゲーションウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。

Parameters

The following parameters are supported for the Map navigation tree widget.

Parameter type name value
Refresh interval 0 rf_rate 0 - No refresh;
10 - 10 seconds;
30 - 30 seconds;
60 - 1 minute;
120 - 2 minutes;
600 - 10 minutes;
900 - (default) 15 minutes.
Show unavailable maps 1 show_unavailable 0 - (default) Disabled;
1 - Enabled.
Reference 1 reference Any string value consisting of 5 characters (e.g. ABCDE, JBPNL, etc.).

Parameter Reference value is used in the Map widget (Linked widget reference) for linking with the Map navigation tree widget.

The following parameters are supported for configuring map navigation tree elements.

Parameter type name value
Name 1 navtree.name.1 Any string value.

Note: The number in the property name sets the element number.
Linked map 8 navtree.sysmapid.1 Map ID.

Note: The number in the property name references the element to which the map is linked.
Parameters for creating element hierarchy 0 navtree.parent.1 Parent element number.

Note: The number in the property name references the child element. The property value references the parent element.
0 navtree.order.1 Element position in the map navigation tree.

Note: The number in the property name references the element number. The property value references the element position in the map navigation tree. Parent element position is determined within the whole map navigation tree. Child element position is determined within the parent element.

次の例は、マップナビゲーションウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。

マップナビゲーションウィジェットの設定

以下のマップナビゲーションツリーを表示するマップナビゲーションウィジェットを設定します:

リクエスト:

{
           "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": 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": "HJQXF"
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "id": 1
       }

レスポンス:

{
           "jsonrpc": "2.0",
           "result": {
               "dashboardids": [
                   "3"
               ]
           },
           "id": 1
       }

参照