kibana/docs/visualize/regionmap.asciidoc
Nick Peihl d7af695564
Add distinct links and float tags to Region Map docs (#20361)
The float tags are required here to keep the subheadings on the same
page in the website. And, since link tags are global, we need to give them unique
names to avoid cross-linking errors.

These changes need to be backported to all 6.X releases.
2018-07-03 10:07:27 -07:00

49 lines
No EOL
1.9 KiB
Text

[[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[]
[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]
==== Data
[float]
===== Metrics
Select any of the supported _Metric_ or _Sibling Pipeline Aggregations_.
[float]
===== Buckets
Configure a _Terms_ aggregation. The term is the _key_ that is used 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.
- *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..