mirror of https://github.com/grafana/grafana
Geomap: Update Documentation (#53552)
Co-authored-by: Ryan McKinley <ryantxu@gmail.com> Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com> Co-authored-by: Nathan Marrs <nathanielmarrs@gmail.com>pull/53704/head
Drew Slobodnjak
3 years ago
committed by
GitHub
parent
f093c249ac
commit
ef24453b9b
@ -0,0 +1,44 @@ |
|||||||
|
--- |
||||||
|
aliases: |
||||||
|
- /docs/grafana/latest/features/panels/geomap/arcgis/ |
||||||
|
- /docs/grafana/latest/panels/visualizations/geomap/arcgis/ |
||||||
|
description: ArcGIS layer |
||||||
|
keywords: |
||||||
|
- grafana |
||||||
|
- Geomap |
||||||
|
- panel |
||||||
|
- documentation |
||||||
|
title: ArcGIS layer |
||||||
|
weight: 400 |
||||||
|
--- |
||||||
|
|
||||||
|
# ArcGIS layer |
||||||
|
|
||||||
|
An ArcGIS layer is a layer from an ESRI ArcGIS MapServer. |
||||||
|
|
||||||
|
## Options |
||||||
|
|
||||||
|
- **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="1200px" caption="Geomap panel ArcGIS World Street Map" >}} |
||||||
|
- World Imagery |
||||||
|
{{< figure src="/static/img/docs/geomap-panel/geomap-arcgis-wi-9-1-0.png" max-width="1200px" caption="Geomap panel ArcGIS World Imagery" >}} |
||||||
|
- World Physical |
||||||
|
{{< figure src="/static/img/docs/geomap-panel/geomap-arcgis-wp-9-1-0.png" max-width="1200px" caption="Geomap panel ArcGIS World Physical" >}} |
||||||
|
- Topographic |
||||||
|
{{< figure src="/static/img/docs/geomap-panel/geomap-arcgis-topographic-9-1-0.png" max-width="1200px" caption="Geomap panel ArcGIS Topographic" >}} |
||||||
|
- USA Topographic |
||||||
|
{{< figure src="/static/img/docs/geomap-panel/geomap-arcgis-usa-topographic-9-1-0.png" max-width="1200px" caption="Geomap panel ArcGIS USA Topographic" >}} |
||||||
|
- World Ocean |
||||||
|
{{< figure src="/static/img/docs/geomap-panel/geomap-arcgis-ocean-9-1-0.png" max-width="1200px" caption="Geomap panel ArcGIS World Ocean" >}} |
||||||
|
- Custom MapServer (see [XYZ]({{< relref "xyz/" >}}) for formatting) |
||||||
|
- URL template |
||||||
|
- Attribution |
||||||
|
- **Opacity** from 0 (transparent) to 1 (opaque) |
||||||
|
|
||||||
|
{{< figure src="/static/img/docs/geomap-panel/geomap-arcgis-options-9-1-0.png" max-width="1200px" caption="Geomap panel ArcGIS options" >}} |
||||||
|
|
||||||
|
## More Information |
||||||
|
|
||||||
|
- [**ArcGIS Services**](https://services.arcgisonline.com/arcgis/rest/services) |
||||||
|
- [**About ESRI**](https://www.esri.com/en-us/about/about-esri/overview) |
||||||
@ -0,0 +1,34 @@ |
|||||||
|
--- |
||||||
|
aliases: |
||||||
|
- /docs/grafana/latest/features/panels/geomap/carto/ |
||||||
|
- /docs/grafana/latest/panels/visualizations/geomap/carto/ |
||||||
|
description: CARTO layer |
||||||
|
keywords: |
||||||
|
- grafana |
||||||
|
- Geomap |
||||||
|
- panel |
||||||
|
- documentation |
||||||
|
title: CARTO layer |
||||||
|
weight: 400 |
||||||
|
--- |
||||||
|
|
||||||
|
# CARTO layer |
||||||
|
|
||||||
|
A CARTO layer is from CARTO Raster basemaps. |
||||||
|
|
||||||
|
## Options |
||||||
|
|
||||||
|
- **Theme** |
||||||
|
- Auto |
||||||
|
- Light |
||||||
|
{{< figure src="/static/img/docs/geomap-panel/geomap-carto-light-9-1-0.png" max-width="1200px" caption="Geomap panel CARTO light example" >}} |
||||||
|
- Dark |
||||||
|
{{< figure src="/static/img/docs/geomap-panel/geomap-carto-dark-9-1-0.png" max-width="1200px" caption="Geomap panel CARTO dark example" >}} |
||||||
|
- **Show labels** shows the Country details on top of the map. |
||||||
|
- **Opacity** from 0 (transparent) to 1 (opaque) |
||||||
|
|
||||||
|
{{< figure src="/static/img/docs/geomap-panel/geomap-carto-options-9-1-0.png" max-width="1200px" caption="Geomap panel CARTO options" >}} |
||||||
|
|
||||||
|
## More Information |
||||||
|
|
||||||
|
- [**About CARTO**](https://carto.com/about-us/) |
||||||
@ -0,0 +1,96 @@ |
|||||||
|
--- |
||||||
|
aliases: |
||||||
|
- /docs/grafana/latest/features/panels/geomap/controls/ |
||||||
|
- /docs/grafana/latest/panels/visualizations/geomap/controls/ |
||||||
|
description: Map Controls |
||||||
|
keywords: |
||||||
|
- grafana |
||||||
|
- Geomap |
||||||
|
- panel |
||||||
|
- documentation |
||||||
|
title: Map controls |
||||||
|
weight: 500 |
||||||
|
--- |
||||||
|
|
||||||
|
# Map Controls |
||||||
|
|
||||||
|
The map controls section contains various options for map information and tool overlays. |
||||||
|
{{< figure src="/static/img/docs/geomap-panel/geomap-map-controls-9-1-0.png" max-width="1200px" caption="Geomap panel map controls" >}} |
||||||
|
|
||||||
|
## 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. |
||||||
|
|
||||||
|
{{< figure src="/static/img/docs/geomap-panel/geomap-map-controls-zoom-9-1-0.png" max-width="1200px" caption="Geomap panel zoom" >}} |
||||||
|
|
||||||
|
### Mouse wheel zoom |
||||||
|
|
||||||
|
Enables the mouse wheel to be used for zooming in or out. |
||||||
|
|
||||||
|
## Show attribution |
||||||
|
|
||||||
|
Displays attribution for basemap layers. |
||||||
|
|
||||||
|
{{< figure src="/static/img/docs/geomap-panel/geomap-map-controls-attribution-9-1-0.png" max-width="1200px" caption="Geomap panel attribution" >}} |
||||||
|
|
||||||
|
## Show scale |
||||||
|
|
||||||
|
Displays scale information in the bottom left corner. |
||||||
|
|
||||||
|
{{< figure src="/static/img/docs/geomap-panel/geomap-map-controls-scale-9-1-0.png" max-width="1200px" caption="Geomap panel scale" >}} |
||||||
|
|
||||||
|
> **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. |
||||||
|
|
||||||
|
{{< figure src="/static/img/docs/geomap-panel/geomap-map-controls-measure-9-1-0.png" max-width="1200px" caption="Geomap panel measure" >}} |
||||||
|
|
||||||
|
- **Click** to start measuring |
||||||
|
- **Continue clicking** to continue measurement |
||||||
|
- **Double-click** to end measurement |
||||||
|
|
||||||
|
> **Note:** <br /> - When you change measurement type or units, the previous measurement is removed from the map. <br /> - If the control is closed and then re-opened, the most recent measurement is displayed. <br /> - 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="1200px" caption="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="1200px" caption="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="1200px" caption="Geomap panel debug" >}} |
||||||
|
|
||||||
|
## Tooltip |
||||||
|
|
||||||
|
- **None** displays tooltips only when a data point is clicked. |
||||||
|
- **Details** displays tooltips when a mouse pointer hovers over a data point. |
||||||
@ -0,0 +1,32 @@ |
|||||||
|
--- |
||||||
|
aliases: |
||||||
|
- /docs/grafana/latest/features/panels/geomap/daynight/ |
||||||
|
- /docs/grafana/latest/panels/visualizations/geomap/daynight/ |
||||||
|
description: Night / Day layer |
||||||
|
keywords: |
||||||
|
- grafana |
||||||
|
- Geomap |
||||||
|
- panel |
||||||
|
- documentation |
||||||
|
title: Night / Day layer |
||||||
|
weight: 400 |
||||||
|
--- |
||||||
|
|
||||||
|
# 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="1200px" caption="Geomap panel Night / Day" >}} |
||||||
|
|
||||||
|
## 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) |
||||||
|
|
||||||
|
{{< figure src="/static/img/docs/geomap-panel/geomap-day-night-options-9-1-0.png" max-width="1200px" caption="Geomap panel Night / Day options" >}} |
||||||
|
|
||||||
|
## More information |
||||||
|
|
||||||
|
- [**Extensions for OpenLayers - DayNight**](https://viglino.github.io/ol-ext/examples/layer/map.daynight.html) |
||||||
@ -0,0 +1,27 @@ |
|||||||
|
--- |
||||||
|
aliases: |
||||||
|
- /docs/grafana/latest/features/panels/geomap/geojson/ |
||||||
|
- /docs/grafana/latest/panels/visualizations/geomap/geojson/ |
||||||
|
description: GeoJSON layer |
||||||
|
keywords: |
||||||
|
- grafana |
||||||
|
- Geomap |
||||||
|
- panel |
||||||
|
- documentation |
||||||
|
title: GeoJSON layer |
||||||
|
weight: 400 |
||||||
|
--- |
||||||
|
|
||||||
|
# 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. |
||||||
@ -0,0 +1,30 @@ |
|||||||
|
--- |
||||||
|
aliases: |
||||||
|
- /docs/grafana/latest/features/panels/geomap/heatmap/ |
||||||
|
- /docs/grafana/latest/panels/visualizations/geomap/heatmap/ |
||||||
|
description: Heatmap layer |
||||||
|
keywords: |
||||||
|
- grafana |
||||||
|
- Geomap |
||||||
|
- panel |
||||||
|
- documentation |
||||||
|
title: Heatmap layer |
||||||
|
weight: 500 |
||||||
|
--- |
||||||
|
|
||||||
|
# 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. |
||||||
@ -0,0 +1,26 @@ |
|||||||
|
--- |
||||||
|
aliases: |
||||||
|
- /docs/grafana/latest/features/panels/geomap/markers/ |
||||||
|
- /docs/grafana/latest/panels/visualizations/geomap/markers/ |
||||||
|
description: Markers layer |
||||||
|
keywords: |
||||||
|
- grafana |
||||||
|
- Geomap |
||||||
|
- panel |
||||||
|
- documentation |
||||||
|
title: Markers layer |
||||||
|
weight: 600 |
||||||
|
--- |
||||||
|
|
||||||
|
# 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. |
||||||
@ -0,0 +1,29 @@ |
|||||||
|
--- |
||||||
|
aliases: |
||||||
|
- /docs/grafana/latest/features/panels/geomap/osm/ |
||||||
|
- /docs/grafana/latest/panels/visualizations/geomap/osm/ |
||||||
|
description: Open street map layer |
||||||
|
keywords: |
||||||
|
- grafana |
||||||
|
- Geomap |
||||||
|
- panel |
||||||
|
- documentation |
||||||
|
title: Open street map layer |
||||||
|
weight: 400 |
||||||
|
--- |
||||||
|
|
||||||
|
# Open Street Map 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="1200px" caption="Geomap panel Open Street Map" >}} |
||||||
|
|
||||||
|
## Options |
||||||
|
|
||||||
|
- **Opacity** from 0 (transparent) to 1 (opaque) |
||||||
|
|
||||||
|
{{< figure src="/static/img/docs/geomap-panel/geomap-osm-options-9-1-0.png" max-width="1200px" caption="Geomap panel Open Street Map options" >}} |
||||||
|
|
||||||
|
## More Information |
||||||
|
|
||||||
|
- [**About Open Street Map**](https://www.openstreetmap.org/about) |
||||||
@ -0,0 +1,35 @@ |
|||||||
|
--- |
||||||
|
aliases: |
||||||
|
- /docs/grafana/latest/features/panels/geomap/zyx/ |
||||||
|
- /docs/grafana/latest/panels/visualizations/geomap/zyx/ |
||||||
|
description: ArcGIS layer |
||||||
|
keywords: |
||||||
|
- grafana |
||||||
|
- Geomap |
||||||
|
- panel |
||||||
|
- documentation |
||||||
|
title: XYZ tile layer |
||||||
|
weight: 400 |
||||||
|
--- |
||||||
|
|
||||||
|
# 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="1200px" caption="Geomap panel xyz example" >}} |
||||||
|
|
||||||
|
## 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]({{< relref "controls/#show-attribution" >}}) |
||||||
|
- **Opacity** from 0 (transparent) to 1 (opaque) |
||||||
|
|
||||||
|
{{< figure src="/static/img/docs/geomap-panel/geomap-xyz-options-9-1-0.png" max-width="1200px" caption="Geomap panel xyz options" >}} |
||||||
|
|
||||||
|
## More information |
||||||
|
|
||||||
|
- [**Tiled Web Map Wikipedia**](https://en.wikipedia.org/wiki/Tiled_web_map) |
||||||
|
- [**List of Open Street Map Tile Servers**](https://wiki.openstreetmap.org/wiki/Tile_servers) |
||||||
Loading…
Reference in new issue