[comment]: # ({5d9c8f6f-36d63c25})
# 13 地图
[comment]: # ({/5d9c8f6f-36d63c25})
[comment]: # ({7168bc3f-5d3b49a4})
### 描述
这些参数及对应仪表板小组件字段objects的可选属性值允许通过`dashboard.create`和`dashboard.update`方法配置[*Map*](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets/map)小组件。
::: noteimportant
小组件`fields`的属性在仪表板创建或update过程中不会被验证。
这使得用户可以修改[built-in widgets](/manual/web_interface/frontend_sections/monitoring/dashboard/widgets)和create[开发模块](/manual/modules#开发模块)，但也存在错误创建或更新小组件的风险。
为确保*地图*小组件成功创建或update，请参考下文表格中列出的参数要求。
:::
[comment]: # ({/7168bc3f-5d3b49a4})
[comment]: # ({490eaaac-e91ef9af})
### 参数
*地图*部件支持以下参数。
| 参数 | [仪表板小部件字段](/manual/api/reference/dashboard/object#仪表板小部件字段) | 名称 | 值 |
|-----|-|-----|-------------------|
| *Refresh interval* | 0 | rf_rate | 0 - 不刷新;
10 - 10秒;
30 - 30秒;
60 - 1分钟;
120 - 2分钟;
600 - 10分钟;
900 - *(默认)* 15分钟。 |
| *Source type* | 0 | source_type | 1 - *(默认)* 地图;
2 - 地图导航树。 |
| *Map* | 8 | sysmapid | [Map](/manual/api/reference/map/get) ID。
如果*源类型*设置为"地图"，则需要参数*地图*。 |
| *Linked widget reference* | 1 | filter_widget_reference | 有效的[*Map navigation tree*](/manual/api/reference/dashboard/widget_fields/map_tree)部件参数*引用*值。
如果*源类型*设置为"地图导航树"，则需要参数*链接部件引用*。 |
[comment]: # ({/490eaaac-e91ef9af})
[comment]: # ({1509d89a-85e84f33})
### 示例
以下示例仅描述*地图*小部件的仪表板小部件字段objects的配置。
有关配置仪表板的更多信息，请参阅[`dashboard.create`](/manual/api/reference/dashboard/create)。
[comment]: # ({/1509d89a-85e84f33})
[comment]: # ({56430e8e-ce6f770b})
#### 配置 *地图* 部件
配置一个显示地图"1"的*地图*部件。
请求:
```json
{
"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": 18,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 8,
"name": "sysmapid",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
[comment]: # ({/56430e8e-ce6f770b})
[comment]: # ({e2deece3-a52bd53b})
#### 配置关联的 *Map* 部件
配置一个与[配置-地图导航树-部件](/manual/api/reference/dashboard/widget_fields/map_tree#配置-地图导航树-部件)部件关联的*地图*部件.
请求:
```json
{
"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": 18,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "source_type",
"value": 2
},
{
"type": 1,
"name": "filter_widget_reference",
"value": "ABCDE"
}
]
},
{
"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
}
```
响应:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
[comment]: # ({/e2deece3-a52bd53b})
[comment]: # ({68e104c3-b648e5e7})
### 另请参阅
- [仪表板小部件字段](/manual/api/reference/dashboard/object#仪表板小部件字段)
- [`dashboard.create`](/manual/api/reference/dashboard/create)
- [`dashboard.update`](/manual/api/reference/dashboard/update)
- [Map navigation tree](/manual/api/reference/dashboard/widget_fields/map_tree)
[comment]: # ({/68e104c3-b648e5e7})