kibana/docs/visualize/regionmap.asciidoc
2020-01-21 14:01:28 -06:00

53 lines
2.4 KiB
Text
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[[regionmap]]
== Region Maps
Region maps are thematic maps in which boundary vector shapes are colored using a gradient:
higher intensity colors indicate larger values, and lower intensity colors indicate smaller values.
These are also known as choropleth maps.
Kibanas out-of-the-box settings do not show a region map in the New Visualization menu. Use <<maps>> instead, which offers more functionality and is easier to use.
If you want to create new region map visualizations, set `xpack.maps.showMapVisualizationTypes` to `true`.
image::images/regionmap.png[]
[float]
[[regionmap-configuration]]
=== Configuration
To create a region map, you configure an inner join that joins the result of an Elasticsearch terms aggregation
and a reference vector file based on a shared key.
[float]
[[region-map-aggregation]]
=== Supported aggregations
Region maps support the following aggregations:
* <<visualize-metric-aggregations,Metric>>
* <<visualize-sibling-pipeline-aggregations,Sibling pipeline>>
* <<visualize-bucket-aggregations,Terms bucket aggregation>>
Use the _key_ term to join the results to the vector data on the map.
[float]
==== Options
[float]
===== Layer Settings
- *Vector map*: select from a list of vector maps. This list includes the maps that are hosted by the © https://www.elastic.co/elastic-maps-service[Elastic Maps Service],
as well as your self-hosted layers that are configured in the *config/kibana.yml* file. To learn more about how to configure Kibana
to make self-hosted layers available, see the <<regionmap-settings,regionmap settings>> documentation. You can also explore and preview vector layers available in Elastic Maps Service at https://maps.elastic.co[https://maps.elastic.co].
- *Join field*: this is the property from the selected vector map that will be used to join on the terms in your terms-aggregation.
When terms cannot be joined to any of the shapes in the vector layer because there is no exact match in the vector layer, Kibana will display a warning.
To turn of these warnings, go to *Management/Kibana/Advanced Settings* and set `visualization:regionmap:showWarnings` to `false`.
[float]
===== Style Settings
- *Color Schema*: the color range used to color the shapes.
[float]
===== Basic Settings
- *Legend Position*: the location on the screen where the legend should be rendered.
- *Show Tooltip*: indicates whether a tooltip should be displayed when hovering over a shape..