Table of Contents
18 Map
Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure the Map widget in dashboard.create and dashboard.update methods.
Widget fields properties are not validated during the creation or update of a dashboard. This allows users to modify built-in widgets and create custom widgets, but also introduces the risk of creating or updating widgets incorrectly. To ensure the successful creation or update of the Map widget, please refer to the parameter behavior outlined in the tables below.
Parameters
The following parameters are supported for the Map 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. |
|
| Map | 8 | sysmapid.0 | Map ID. Parameter behavior: - required if Map (Widget) is not set |
|
| Map (Widget) | 1 | sysmapid._reference | ABCDE._mapid - set a Map navigation tree widget (with its Reference parameter set to "ABCDE") as the data source for maps.Parameter behavior: - required if Map is not set |
|
| Reference | 1 | reference | Any string value consisting of 5 characters (e.g., ABCDE or JBPNL). This value must be unique within the dashboard to which the widget belongs.Parameter behavior: - required |
|
Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the Map widget. For more information on configuring a dashboard, see dashboard.create.
Configuring a Map widget
Configure a Map widget that displays the map "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
}Response:
Configuring a linked Map widget
Configure a Map widget that is linked to a Map navigation tree widget.
{
"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
}Response: