2017-06-30 05:49:26 +02:00
[[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.
image::images/regionmap.png[]
2018-07-03 23:43:52 +02:00
[float]
[[regionmap-configuration]]
2017-06-30 05:49:26 +02:00
=== 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.
2018-07-03 23:43:52 +02:00
[float]
2017-06-30 05:49:26 +02:00
==== Data
2018-07-03 23:43:52 +02:00
[float]
2017-06-30 05:49:26 +02:00
===== Metrics
Select any of the supported _Metric_ or _Sibling Pipeline Aggregations_.
2018-07-03 23:43:52 +02:00
[float]
2017-06-30 05:49:26 +02:00
===== Buckets
Configure a _Terms_ aggregation. The term is the _key_ that is used to join the results to the vector data on the map.
2018-07-03 23:43:52 +02:00
[float]
2017-06-30 05:49:26 +02:00
==== Options
2018-07-03 23:43:52 +02:00
[float]
2017-06-30 05:49:26 +02:00
===== Layer Settings
2017-08-03 20:46:16 +02:00
- *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],
2017-06-30 05:49:26 +02:00
as well as your self-hosted layers that are configured in the *config/kibana.yml* file. To learn more about how to configure Kibana
2018-07-17 18:19:40 +02:00
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].
2017-08-03 20:46:16 +02:00
- *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.
2017-08-03 20:52:34 +02:00
To turn of these warnings, go to *Management/Kibana/Advanced Settings* and set `visualization:regionmap:showWarnings` to `false`.
2017-06-30 05:49:26 +02:00
2018-07-03 23:43:52 +02:00
[float]
2017-06-30 05:49:26 +02:00
===== Style Settings
- *Color Schema*: the color range used to color the shapes.
2018-07-03 23:43:52 +02:00
[float]
2017-06-30 05:49:26 +02:00
===== 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..