Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Panels and visualizations

Visualizations

Geomap

Enterprise Open source

Geomap

The Geomap panel visualization allows you to view and customize the world map using geospatial data. You can configure various overlay styles and map view settings to easily focus on the important location-based characteristics of the data.

Map View

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

Initial View

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

View sets the center for the map when the panel first loads.
- Fit to data fits the map view based on the data extents of Map layers and updates when data changes.
  - Data option allows selection of extent based on data from “All layers”, a single “Layer”, or the “Last value” from a selected layer.
  - Layer can be selected if fitting data from a single “Layer” or the “Last value” of a layer.
  - Padding sets padding in relative percent beyond data extent (not available when looking at “Last value” only).
  - Max Zoom sets the maximum zoom level when fitting data.
- Coordinates sets the map view based on:
  - Latitude
  - Longitude
- Default Views are also available including:
  - (0°, 0°)
  - North America
  - South America
  - Europe
  - Africa
  - West Asia
  - South Asia
  - South-East Asia
  - East Asia
  - Australia
  - Oceania
Zoom sets the initial zoom level.

Map layers

The Geomap visualization supports showing multiple layers. Each layer determines how you visualize geospatial data on top of the base map.

Types

There are three map layer types to choose from in the Geomap visualization.

Markers renders a marker at each data point.
Heatmap visualizes a heatmap of the data.
GeoJSON renders static data from a GeoJSON file.

There are also five alpha layer types.

Night / Day (alpha) renders a night / day region.
Icon at last point (alpha) renders an icon at the last data point.
Dynamic GeoJSON (alpha) styles a GeoJSON file based on query results.
Route (alpha) render data points as a route.
Photos layer (Alpha) renders a photo at each data point.

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

Layer Controls

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 visualization. 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.
The layer controls allow you to rename, delete, and reorder the layers of the panel.
- 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 panel 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 panel in order to create rich, detailed visualizations.

Location

The Geomap panel needs a source of geographical data. This data comes from a database query, and there are four mapping options for your data.

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.

Basemap layer

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.

Types

There are four basemap layer types to choose from in the Geomap visualization.

Open Street Map adds a map from a collaborative free geographic world database.
CARTO adds a layer from CARTO Raster basemaps.
ArcGIS adds a layer from an ESRI ArcGIS MapServer.
XYZ adds a map from a generic tile layer.

Default

The default base 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 four base map options to choose from: carto, esri-xyz, osm-standard, xyz. 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 = `{
  "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:

geomap_default_baselayer = `{
  "type": "esri-xyz",
  "config": {
    "server": "world-imagery"
  }
}`

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

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": "Open street map",
    "url": "https://tile.openstreetmap.org/{z}/{x}/{y}.png"
  }
}`

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

Markers layer

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

Marker Color configures the color of the marker. The default Single color keeps all points a single color. There is an alternate option to have multiple colors depending on the data point values and the threshold set at the Thresholds section.
Marker Size configures the size of the marker. The default is Fixed size, which makes all marker sizes the same regardless of the data points. However, there is also an option to scale the circles to the corresponding data points. Min and Max marker size has to be set such that the Marker layer can scale within this range.
Marker Shape allows you to choose the shape, icon, or graphic to aid in providing additional visual context to your data. Choose from assets that are included with Grafana such as simple shapes or the Unicon library. You can also specify a URL containing an image asset. The image must be a scalable vector graphic (SVG).
Fill opacity configures the transparency of each marker.

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.

Weight values configure the intensity of the heatmap clusters. Fixed value keeps a constant weight value throughout all data points. This value should be in the range of 0~1. Similar to Markers, there is an alternate option in the drop-down to automatically scale the weight values depending on data values.
Radius configures the size of the heatmap clusters.
Blur configures the amount of blur on each cluster.

GeoJSON layer

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

GeoJSON URL provides a choice of GeoJSON files that ship with Grafana.
Default Style controls which styles to apply when no rules above match.
- Color configures the color of the default style
- Opacity configures the default opacity
Style Rules apply styles based on feature properties
- Rule allows you to select a feature, condition, and value from the GeoJSON file in order to define a rule. The trash bin icon can be used to delete the current rule.
- Color configures the color of the style for the current rule
- Opacity configures the transparency level for the current rule
Add style rule creates additional style rules.

CARTO layer

A CARTO layer is from CARTO Raster basemaps.

Options

Theme
- Auto
- Light
  Geomap panel CARTO light example
- Dark
  Geomap panel CARTO dark example
Show labels shows the Country details on top of the map.
Opacity from 0 (transparent) to 1 (opaque)

More Information

About CARTO

XYZ tile layer

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

Options

URL template
Note: Set a valid tile server url, with {z}/{x}/{y} for example: https://tile.openstreetmap.org/{z}/{x}/{y}.png
Attribution sets the reference string for the layer if displayed in map controls
Opacity from 0 (transparent) to 1 (opaque)

More information

Open Street Map layer

A map from a collaborative free geographic world database.

Options

Opacity from 0 (transparent) to 1 (opaque)

More Information

About Open Street Map\

ArcGIS layer

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

Options

Server Instance to select the map type.
- World Street Map
  Geomap panel ArcGIS World Street Map
- World Imagery
  Geomap panel ArcGIS World Imagery
- World Physical
  Geomap panel ArcGIS World Physical
- Topographic
  Geomap panel ArcGIS Topographic
- USA Topographic
  Geomap panel ArcGIS USA Topographic
- World Ocean
  Geomap panel ArcGIS World Ocean
- Custom MapServer (see XYZ for formatting)
  - URL template
  - Attribution
Opacity from 0 (transparent) to 1 (opaque)
Geomap panel ArcGIS options

More Information

Night / Day layer (Alpha)

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

To enable the Night / Day layer, set enable_alpha to true in your configuration file:

[panels]
enable_alpha = true

To enable the Photos layer using Docker, run the following command:

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

Options

Show toggles time source from panel time range
Night region color picks color for night region
Display sun toggles sun icon
Opacity from 0 (transparent) to 1 (opaque)

More information

Extensions for OpenLayers - DayNight

Photos layer (Alpha)

The Photos layer renders a photo at each data point.

To enable the Photos layer, set enable_alpha to true in your configuration file:

[panels]
enable_alpha = true

To enable the Photos layer using Docker, run the following command:

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

Options

Image Source Field select a string field containing image data in either of the following formats
- Image URLs
- Base64 encoded image binary (“data:image/png;base64,…”)
Kind select the frame style around the images
- Square
- Circle
- Anchored
- Folio
Crop toggle if the images are cropped to fit
Shadow toggle a box shadow behind the images
Border set the border size around images
Border color set the border color around images
Radius set the overall size of images in pixels

More information

Extensions for OpenLayers - Image Photo Style

Map Controls

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

Zoom

This section describes each of the zoom controls.

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.

Mouse wheel zoom

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

Show attribution

Displays attribution for basemap layers.

Show scale

Displays scale information in the bottom left corner.

Note: Currently only displays units in [m]/[km].

Show measure tools

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

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

Note:
- 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)

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’.