Geomap

Geomaps allow you to view and customize the world map using geospatial data. It's the ideal visualization if you have data that includes location information and you want to see it displayed in a map.

You can configure and overlay map layers, like heatmaps and networks, and blend included basemaps or your own custom maps. This helps you to easily focus on the important location-based characteristics of the data.

{{< figure src="/static/img/docs/geomap-panel/geomap-example-8-1-0.png" max-width="750px" alt="Geomap visualization" >}}

When a geomap is in focus, in addition to typical mouse controls, you can pan around using the arrow keys or zoom in and out using the plus (+) and minus (-) keys or icons.

Geomaps are also useful when you have location data that’s changing in real time and you want to visualize where an element is moving, using auto-refresh.

You can use a geomap visualization if you need to:

• Track your fleet of vehicles and associated metrics
• Show the locations and statuses of data centers or other connected assets in a network
• Display geographic trends in a heatmap
• Visualize the relationship of your locations' HVAC consumption or solar production with the sun's location

{{< admonition type="note" >}} We'd love your feedback on the geomap visualization. Please check out the open Github issues and submit a new feature request as needed. {{< /admonition >}}

Configure a geomap visualization

The following video provides beginner steps for creating geomap visualizations. You'll learn the data requirements and caveats, special customizations, preconfigured displays and much more:

{{< youtube id="HwM8AFQ7EUs" >}}

{{< docs/play title="Geomap Examples" url="https://play.grafana.org/d/panel-geomap/" >}}

Supported data formats

To create a geomap visualization, you need datasets containing fields with location information.

The supported location formats are:

• Latitude and longitude
• Geohash
• Lookup codes: country, US states, or airports

To learn more, refer to Location mode.

Geomaps also support additional fields with various data types to define things like labels, numbers, heat sizes, and colors.

Example - Latitude and longitude

If you plan to use latitude and longitude coordinates, the dataset must include at least two fields (or columns): one called latitude (you can also uselat), and one called longitude (also lon or lng). When you use this naming convention, the visualization automatically detects the fields and displays the elements. The order of the fields doesn't matter as long as there is one latitude and one longitude.

If your latitude and longitude fields are named differently, you can specify them, as indicated in the Location mode section.

Example - Geohash

If your location data is in geohash format, the visualization requires at least one field (or column) containing location data.

If the field is named geohash, the visualization automatically detects the location and displays the elements. The order of the fields doesn't matter and the data set can have multiple other numeric, text, and time fields.

If your field containing geohash location data is not named as above, you can configure the visualization to use geohash and specify which field to use, as explained in the Location mode section.

Example - Lookup codes

The geomap visualization can identify locations based on country, airport, or US state codes.

For this configuration, the dataset must contain at least one field (or column) containing the location code.

If the field is named lookup, the visualization automatically detects it and displays points based on country codes.

The other location types— airport codes or US state codes—aren't automatically detected.

If you want to use other codes or give the field a custom name, you can follow the steps in the Location mode section.

Configuration options

Panel options

{{< docs/shared lookup="visualizations/panel-options.md" source="grafana" version="<GRAFANA_VERSION>" >}}

Map view options

The map view controls the initial view of the map when the dashboard loads.

Initial View

The initial view configures how the geomap renders when the panel is first loaded.

• View - Sets the center for the map when the panel first loads. Refer to the table following this list for view selections.
• Zoom - Sets the initial zoom level.
• Use current map settings - Use the settings of the current map to set the center.

Default Views are also available including:

Share view

The Share view option allows you to link the movement and zoom actions of multiple map visualizations within the same dashboard. The map visualizations that have this option enabled act in tandem when one of them is moved or zoomed, leaving the other ones independent.

{{< admonition type="note" >}} You might need to reload the dashboard for this feature to work. {{< /admonition >}}

No map repeating

The No map repeating option prevents the base map tiles from repeating horizontally when you pan across the world. This constrains the view to a single instance of the world map and avoids visual confusion when displaying global datasets. Enabling this option requires the map to reinitialize.

Sync view to dashboard variable

Stores the current map's view extents in a dashboard variable of your choosing. This is particularly useful for dynamically querying data based on the map's current extents.

To use the option, follow these steps:

1. Create a Custom type dashboard variable.
2. Return to panel configuration and toggle on this switch.
3. Select the newly created variable from the Variable name drop-down list.
4. Use the variable in your queries.

The variable contains comma-separated coordinates (EPSG:4326): minLon,minLat,maxLon,maxLat

Map layers options

Geomaps support showing multiple layers. Each layer determines how you visualize geospatial data on top of the base map.

There are three options that you need to set for all maps:

• Layer type
• Data
• Location mode

Other options are dependent on your map layer type and are described within the layer type section.

The layer controls allow you to create layers, change their name, reorder and delete layers.

• Add layer creates an additional, configurable data layer for the geomap. When you add a layer, you are prompted to select a layer type. You can change the layer type at any point during panel configuration. See the Layer Types section above for details on each layer type.
• Edit layer name (pencil icon) renames the layer.
• Trash Bin deletes the layer.
• Reorder (six dots/grab handle) allows you to change the layer order. Data on higher layers will appear above data on lower layers. The visualization will update the layer order as you drag and drop to help simplify choosing a layer order.

You can add multiple layers of data to a single geomap in order to create rich, detailed visualizations.

Layer type

Geomap has nine data layer types and five basemap layer types.

• Markers renders a marker at each data point.
• Heatmap visualizes a heatmap of the data.
• GeoJSON renders static data from a GeoJSON file.
• Night / Day renders a night / day region.
• Route render data points as a route.
• Photos renders a photo at each data point.
• Network visualizes a network graph from the data.
• OpenStreetMap adds a map from a collaborative free geographic world database.
• CARTO basemap adds a layer from CARTO Raster basemaps.
• ArcGIS MapServer adds a layer from an ESRI ArcGIS MapServer.
• XYZ Tile layer adds a map from a generic tile layer.
• MapLibre Style layer adds a map from a MapLibre/Mapbox style URL.

There are also two experimental, alpha layer types.

• Icon at last point (Alpha) renders an icon at the last data point.
• Dynamic GeoJSON (Alpha) styles a GeoJSON file based on query results. It includes options for GeoJSON URL, ID Field, Data style, and Default style.

To enable experimental layers. Set enable_alpha to true in your configuration file:

[panels]
enable_alpha = true

To enable the experimental layers using Docker, run the following command:

docker run -p 3000:3000 -e "GF_PANELS_ENABLE_ALPHA=true" grafana/grafana:<VERSION>

Data

Geomaps need a source of geographical data gathered from a data source query which can return multiple datasets. By default Grafana picks the first dataset, but this drop-down allows you to pick other datasets if the query returns more than one.

Location Mode

There are four options to map the data returned by the selected query:

• Auto automatically searches for location data. Use this option when your query is based on one of the following names for data fields.
  • geohash: “geohash”
  • latitude: “latitude”, “lat”
  • longitude: “longitude”, “lng”, “lon”
  • lookup: “lookup”
• Coords specifies that your query holds coordinate data. You will get prompted to select numeric data fields for latitude and longitude from your database query.
• Geohash specifies that your query holds geohash data. You will be prompted to select a string data field for the geohash from your database query.
• Lookup specifies that your query holds location name data that needs to be mapped to a value. You will be prompted to select the lookup field from your database query and a gazetteer. The gazetteer is the directory that is used to map your queried data to a geographical point.

Markers layer

The markers layer allows you to display data points as different marker shapes such as circles, squares, triangles, stars, and more.

Heatmap layer

The heatmap layer clusters various data points to visualize locations with different densities. To add a heatmap layer:

Click on the drop-down menu under Data Layer and choose Heatmap.

Similar to Markers, you are prompted with various options to determine which data points to visualize and how you want to visualize them.

GeoJSON layer

The GeoJSON layer allows you to select and load a static GeoJSON file from the filesystem.

Styles can be set within the "properties" object of the GeoJSON with support for the following geometries:

Polygon, MultiPolygon

• "fill" - The color of the interior of the polygon(s)
• "fill-opacity" - The opacity of the interior of the polygon(s)
• "stroke-width" - The width of the line component of the polygon(s)

Point, MultiPoint

• "marker-color" - The color of the point(s)
• "marker-size" - The size of the point(s)

LineString, MultiLineString

• "stroke" - The color of the line(s)
• "stroke-width" - The width of the line(s)

Night / Day layer

The Night / Day layer displays night and day regions based on the current time range.

{{< figure src="/static/img/docs/geomap-panel/geomap-day-night-9-1-0.png" max-width="600px" alt="Geomap panel Night / Day" >}}

Extensions for OpenLayers - DayNight

Route layer

The Route layer renders data points as a route.

{{< figure src="/media/docs/grafana/geomap-route-layer-basic-9-4-0.png" max-width="600px" alt="Geomap panel Route" >}}

The layer can also render a route with arrows.

{{< figure src="/media/docs/grafana/geomap-route-layer-arrow-size-9-4-0.png" max-width="600px" alt="Geomap panel Route arrows with size" >}}

Extensions for OpenLayers - Flow Line Style

Photos layer

The Photos layer renders a photo at each data point.

{{< figure src="/static/img/docs/geomap-panel/geomap-photos-9-3-0.png" max-width="600px" alt="Geomap panel Photos" >}}

Extensions for OpenLayers - Image Photo Style

Network layer

The Network layer renders a network graph. This layer supports the same data format supported by the node graph visualization with the addition of geospatial data included in the nodes data. The geospatial data is used to locate and render the nodes on the map.

{{< figure src="/media/docs/grafana/screenshot-grafana-10-1-geomap-network-layer-v2.png" max-width="750px" alt="Geomap network layer" >}}

You can convert node graph data to a network layer: {{< video-embed src="/media/docs/grafana/screen-recording-10-1-geomap-network-layer-from-node-graph.mp4" max-width="750px" alt="Node graph to Geomap network layer" >}}

Node styles options

Edge styles options

OpenStreetMap layer

A map from a collaborative free geographic world database.

{{< figure src="/static/img/docs/geomap-panel/geomap-osm-9-1-0.png" max-width="600px" alt="Geomap panel OpenStreetMap" >}}

• Opacity from 0 (transparent) to 1 (opaque)
• Display tooltip - allows you to toggle tooltips for the layer.

About OpenStreetMap

CARTO basemap layer

A CARTO layer is from CARTO Raster basemaps.

• Theme
  • Auto
  • Light {{< figure src="/static/img/docs/geomap-panel/geomap-carto-light-9-1-0.png" max-width="600px" alt="Geomap panel CARTO light example" >}}
  • Dark {{< figure src="/static/img/docs/geomap-panel/geomap-carto-dark-9-1-0.png" max-width="600px" alt="Geomap panel CARTO dark example" >}}
• Show labels shows the Country details on top of the map.
• Opacity from 0 (transparent) to 1 (opaque)
• Display tooltip - allows you to toggle tooltips for the layer.

About CARTO

ArcGIS MapServer layer

An ArcGIS layer is a layer from an ESRI ArcGIS MapServer.

• Server Instance to select the map type.
  • World Street Map {{< figure src="/static/img/docs/geomap-panel/geomap-arcgis-wsm-9-1-0.png" max-width="600px" alt="Geomap panel ArcGIS World Street Map" >}}
  • World Imagery {{< figure src="/static/img/docs/geomap-panel/geomap-arcgis-wi-9-1-0.png" max-width="600px" alt="Geomap panel ArcGIS World Imagery" >}}
  • World Physical {{< figure src="/static/img/docs/geomap-panel/geomap-arcgis-wp-9-1-0.png" max-width="600px" alt="Geomap panel ArcGIS World Physical" >}}
  • Topographic {{< figure src="/static/img/docs/geomap-panel/geomap-arcgis-topographic-9-1-0.png" max-width="600px" alt="Geomap panel ArcGIS Topographic" >}}
  • USA Topographic {{< figure src="/static/img/docs/geomap-panel/geomap-arcgis-usa-topographic-9-1-0.png" max-width="600px" alt="Geomap panel ArcGIS USA Topographic" >}}
  • World Ocean {{< figure src="/static/img/docs/geomap-panel/geomap-arcgis-ocean-9-1-0.png" max-width="600px" alt="Geomap panel ArcGIS World Ocean" >}}
  • Custom MapServer (see XYZ for formatting)
    • URL template
    • Attribution
• Opacity from 0 (transparent) to 1 (opaque)
• Display tooltip - allows you to toggle tooltips for the layer.

More Information

• ArcGIS Services
• About ESRI

XYZ Tile layer

The XYZ Tile layer is a map from a generic tile layer.

{{< figure src="/static/img/docs/geomap-panel/geomap-xyz-9-1-0.png" max-width="600px" alt="Geomap panel xyz example" >}}

• URL template - Set a valid tile server URL, with {z}/{x}/{y} for example: https://tile.openstreetmap.org/{z}/{x}/{y}.png. Dashboard variables are supported, for example, https://example.com/maps/${version}/{z}/{x}/{y}.png.
• Attribution sets the reference string for the layer if displayed in map controls. Dashboard variables are supported.
• Min zoom - Minimum zoom level. Tiles aren't loaded below this level.
• Max zoom - Maximum zoom level provided by the server. Beyond this level, the map is rendered by scaling up existing tiles.
• Opacity from 0 (transparent) to 1 (opaque)

More information

• Tiled Web Map Wikipedia
• List of OpenStreetMap Tile Servers

MapLibre Style layer

The MapLibre Style Layer is a map defined using a MapLibre/Mapbox style.json URL. The style contains the URL to the tiles, layer definitions, and more. Typically, they're based on vector tiles as opposed to raster tiles.

• URL template - Set a valid style URL. For example: https://demotiles.maplibre.org/style.json
• Public access token - An API token for mapbox maps. Only works for mapbox:// URLs. Refer to mapbox access tokens documentation for more information. In other cases, you might have to include the token in the URL. For example: https://example.com/map/style.json?key=XXX.

Basemap layer options

A basemap layer provides the visual foundation for a mapping application. It typically contains data with global coverage. Several base layer options are available each with specific configuration options to style the base map.

Basemap layer types can also be added as layers. You can specify an opacity.

There are five basemap layer types to choose from in a geomap.

• OpenStreetMap adds a map from a collaborative free geographic world database.
• CARTO basemap adds a layer from CARTO Raster basemaps.
• ArcGIS MapServer adds a layer from an ESRI ArcGIS MapServer.
• XYZ Tile layer adds a map from a generic tile layer.
• MapLibre Style layer adds a map from a MapLibre/Mapbox style URL.

The default basemap layer uses the CARTO map. You can define custom default base layers in the .ini configuration file.

Configure the default base layer with provisioning

You can configure the default base map using config files with Grafana’s provisioning system. For more information on all the settings, refer to the provisioning docs page.

Use the JSON configuration option default_baselayer_config to define the default base map. There are currently five base map options to choose from: carto, esri-xyz, osm-standard, xyz, maplibre. Here are some provisioning examples for each base map option.

• carto loads the CartoDB tile server. You can choose from auto, dark, and light theme for the base map and can be set as shown below. The showLabels tag determines whether or not Grafana shows the Country details on top of the map. Here is an example:

[geomap]
default_baselayer_config = `{
  "type": "carto",
  "config": {
    "theme": "auto",
    "showLabels": true
  }
}`

• esri-xyz loads the ESRI tile server. There are already multiple server instances implemented to show the various map styles: world-imagery, world-physical, topo, usa-topo, and ocean. The custom server option allows you to configure your own ArcGIS map server. Here are some examples:

{{< tabs >}} {{< tab-content name="World imagery" >}}

[geomap]
default_baselayer_config = `{
  "type": "esri-xyz",
  "config": {
    "server": "world-imagery"
  }
}`

{{< /tab-content >}} {{< tab-content name="Custom" >}}

[geomap]
default_baselayer_config = `{
  "type": "esri-xyz",
  "config": {
    "server": "custom",
    "url": "[tile server url]",
    "attribution": "[tile server attribution]"
  }
}`

{{< /tab-content >}} {{< /tabs >}}

• osm-standard loads the OpenStreetMap tile server. There are no additional configurations needed and the config fields can be left blank. Here is an example:

default_baselayer_config = `{
  "type": "osm-standard",
  "config": {}
}`

• xyz loads a custom tile server defined by the user. Set a valid tile server url, with {z}/{x}/{y} for this option in order to properly load a default base map. Here is an example:

default_baselayer_config = `{
  "type": "xyz",
  "config": {
    "attribution": "OpenStreetMap",
    "url": "https://tile.openstreetmap.org/{z}/{x}/{y}.png"
  }
}`

• maplibre loads a custom tile server defined by the user. Set a valid style url for this option to properly load a default base map. Here's an example:

default_baselayer_config = `{
  "type": "maplibre",
  "config": {
    "url": "https://demotiles.maplibre.org/style.json"
  }
}`

enable_custom_baselayers allows you to enable or disable custom open source base maps that are already implemented. The default is true.

Map controls options

The map controls section contains various options for map information and tool overlays.

Show zoom control

Displays zoom controls in the upper left corner. This control can be useful when using systems that don't have a mouse.

{{< figure src="/static/img/docs/geomap-panel/geomap-map-controls-zoom-9-1-0.png" max-width="300px" alt="Geomap panel zoom" >}}

Mouse wheel zoom

Enables the mouse wheel to be used for zooming in or out.

Show optional attribution

Displays attribution for basemap layers whose license doesn't require it. When a layer license requires attribution, Grafana always displays it and this option has no effect.

{{< figure src="/static/img/docs/geomap-panel/geomap-map-controls-attribution-9-1-0.png" max-width="400px" alt="Geomap panel attribution" >}}

Show scale

Displays scale information in the bottom left corner in meters (m) or kilometers (km).

{{< figure src="/static/img/docs/geomap-panel/geomap-map-controls-scale-9-1-0.png" max-width="400px" alt="Geomap panel scale" >}}

Show measure tools

Displays measure tools in the upper right corner. Measurements appear only when this control is open.

{{< figure src="/static/img/docs/geomap-panel/geomap-map-controls-measure-9-1-0.png" max-width="400px" alt="Geomap panel measure" >}}

• Click to start measuring
• Continue clicking to continue measurement
• Double-click to end measurement

When you change measurement type or units, the previous measurement is removed from the map. If the control is closed and then re-opened, the most recent measurement is displayed. A measurement can be modified by clicking and dragging on it.

Length

Get the spherical length of a geometry. This length is the sum of the great circle distances between coordinates. For multi-part geometries, the length is the sum of the length of each part. Geometries are assumed to be in 'EPSG:3857'.

• Metric (m/km)
• Feet (ft)
• Miles (mi)
• Nautical miles (nmi)

{{< figure src="/static/img/docs/geomap-panel/geomap-map-controls-measure-length-9-1-0.png" max-width="400px" alt="Geomap panel measure length" >}}

Area

Get the spherical area of a geometry. This area is calculated assuming that polygon edges are segments of great circles on a sphere. Geometries are assumed to be in 'EPSG:3857'.

• Square Meters (m²)
• Square Kilometers (km²)
• Square Feet (ft²)
• Square Miles (mi²)
• Acres (acre)
• Hectare (ha)

{{< figure src="/static/img/docs/geomap-panel/geomap-map-controls-measure-area-9-1-0.png" max-width="550px" alt="Geomap panel measure area" >}}

Show debug

Displays debug information in the upper right corner. This can be useful for debugging or validating a data source.

• Zoom displays current zoom level of the map.
• Center displays the current longitude, latitude of the map center.

{{< figure src="/static/img/docs/geomap-panel/geomap-map-controls-debug-9-1-0.png" max-width="400px" alt="Geomap panel debug" >}}

Tooltip

Tooltips are supported for the Markers, Heatmap, Photos layers. For these layer types, choose from the following tooltip options:

• None displays tooltips only when a data point is clicked.
• Details displays tooltips when a mouse pointer hovers over a data point.

When a data point on the geomap represents one row—that is, only a single row of response data is relevant to that point—the tooltip displays a grid with the row's names and values:

{{< figure src="/media/docs/grafana/panels-visualizations/screenshot-single-row-marker-v12.1.png" max-width="750px" alt="A data point with one row of associated data" >}}

When a data point represents more than one row—that is, different rows but with the same geographical information—then each row appears as a single entry:

{{< figure src="/media/docs/grafana/panels-visualizations/screenshot-multiple-row-marker-v12.1.png" max-width="750px" alt="A data point with mulitple rows of associated data" >}}

The text displayed in each tooltip row is associated with the first field value in each data row. Click it to expand and display the full details of the data row.

{{< admonition type="note" >}} The data appearing in each detail row is determined by the underlying query and transformations applied to the query's results, and can't be directly controlled using tooltip options. {{< /admonition >}}

Standard options

{{< docs/shared lookup="visualizations/standard-options.md" source="grafana" version="<GRAFANA_VERSION>" >}}

Data links and actions

{{< docs/shared lookup="visualizations/datalink-options.md" source="grafana" version="<GRAFANA_VERSION>" >}}

Value mappings

{{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="<GRAFANA_VERSION>" >}}

Thresholds

{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="<GRAFANA_VERSION>" >}}

Field overrides

{{< docs/shared lookup="visualizations/overrides-options.md" source="grafana" version="<GRAFANA_VERSION>" >}}