[comment]: # ({2091b9ba-f2076b88})
# 7 Geomap
[comment]: # ({/2091b9ba-f2076b88})
[comment]: # ({6149218e-f4e7e64a})
### Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*Geomap*](/manual/web_interface/frontend_sections/dashboards/widgets/geomap) widget in `dashboard.create` and `dashboard.update` methods.
::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/dashboards/widgets) and create [custom widgets](/devel/modules/tutorials/widget), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *Geomap* widget, please refer to the parameter behavior outlined in the tables below.
:::
[comment]: # ({/6149218e-f4e7e64a})
[comment]: # ({ad560a10-90ce35af})
### Parameters
The following parameters are supported for the *Geomap* widget.
|Parameter|<|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|name|value|
|-|--------|--|--------|-------------------------------|
|*Refresh interval*|<|0|rf_rate|0 - No refresh;
10 - 10 seconds;
30 - 30 seconds;
60 - *(default)* 1 minute;
120 - 2 minutes;
600 - 10 minutes;
900 - 15 minutes.|
|*Host groups*|<|2|groupids.0|[Host group](/manual/api/reference/hostgroup/get) ID.
Note: To configure multiple host groups, create a dashboard widget field object for each host group with an incremented number in the property name.
This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|<|*Host groups (Widget)*|1|groupids.\_reference|Instead of [Host group](/manual/api/reference/hostgroup/get) ID:
`ABCDE._hostgroupids` - set a [compatible widget](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility) (with its *Reference* parameter set to "`ABCDE`") as the data source for host groups.
This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|*Hosts*|<|3|hostids.0|[Host](/manual/api/reference/host/get) ID.
Note: To configure multiple hosts, create a dashboard widget field object for each host with an incremented number in the property name. For multiple hosts, the parameter *Host groups* must either be not configured at all or configured with at least one host group that the configured hosts belong to.
This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|<|*Hosts (Widget/Dashboard)*|1|hostids.\_reference|Instead of [Host](/manual/api/reference/host/get) ID:
`DASHBOARD.hostids` - set the dashboard [host selector](/manual/web_interface/frontend_sections/dashboards/widgets#override-host) as the data source for hosts;
`ABCDE._hostids` - set a [compatible widget](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility) (with its *Reference* parameter set to "`ABCDE`") as the data source for hosts.
This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|*Tags*|<|<|<|<|
|<|*Evaluation type*|0|evaltype|0 - *(default)* And/Or;
2 - Or.
This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|^|*Tag name*|1|tags.0.tag|Any string value.
Note: The number in the property name references tag order in the tag evaluation list.
[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):
- *required* if configuring *Tags*
This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|^|*Operator*|0|tags.0.operator|0 - Contains;
1 - Equals;
2 - Does not contain;
3 - Does not equal;
4 - Exists;
5 - Does not exist.
Note: The number in the property name references tag order in the tag evaluation list.
[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):
- *required* if configuring *Tags*
This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|^|*Tag value*|1|tags.0.value|Any string value.
Note: The number in the property name references tag order in the tag evaluation list.
[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):
- *required* if configuring *Tags*
This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|
|*Initial view*|<|1|default_view|Comma separated *latitude*, *longitude*, *zoom level* (*optional*, possible values range from 0-30).
Example: `40.6892494,-74.0466891,10`.|
|*Clustering*|<|<|<|<|
|<|*Clustering mode*|0|clustering_mode|0 - *(default)* Auto;
1 - Zoom level.|
|^|*Clustering zoom level*|0|clustering_zoom_level|Possible values range from 0-30.
Default: 0.
[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):
- *supported* if *Clustering mode* is set to "Zoom level"|
|*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](/manual/api/reference_commentary#parameter-behavior):
- *required*|
[comment]: # ({/ad560a10-90ce35af})
[comment]: # ({19dde7e3-7eae8154})
### Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the *Geomap* widget.
For more information on configuring a dashboard, see [`dashboard.create`](/manual/api/reference/dashboard/create).
[comment]: # ({/19dde7e3-7eae8154})
[comment]: # ({0a0e2a99-a5de665c})
#### Configuring a *Geomap* widget
Configure a *Geomap* widget that displays hosts from host groups "2" and "22" based on the following tag configuration:
tag with the name "component" contains value "node", and tag with the name "location" equals value "New York".
In addition, set the map initial view to coordinates "40.6892494" (latitude), "-74.0466891" (longitude) with the zoom level "10".
[Request](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "geomap",
"name": "Geomap",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 22
},
{
"type": 2,
"name": "groupids.1",
"value": 2
},
{
"type": 1,
"name": "default_view",
"value": "40.6892494,-74.0466891,10"
},
{
"type": 0,
"name": "evaltype",
"value": 2
},
{
"type": 1,
"name": "tags.0.tag",
"value": "component"
},
{
"type": 0,
"name": "tags.0.operator",
"value": 0
},
{
"type": 1,
"name": "tags.0.value",
"value": "node"
},
{
"type": 1,
"name": "tags.1.tag",
"value": "location"
},
{
"type": 0,
"name": "tags.1.operator",
"value": 1
},
{
"type": 1,
"name": "tags.1.value",
"value": "New York"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
[comment]: # ({/0a0e2a99-a5de665c})
[comment]: # ({e9d30322-cc20c3df})
### See also
- [Dashboard widget field](/manual/api/reference/dashboard/object#dashboard-widget-field)
- [`dashboard.create`](/manual/api/reference/dashboard/create)
- [`dashboard.update`](/manual/api/reference/dashboard/update)
[comment]: # ({/e9d30322-cc20c3df})