From e5ad25c3c121199e254a3790aa95b78da5081ce1 Mon Sep 17 00:00:00 2001 From: Thomas Neirynck Date: Thu, 3 Aug 2017 14:46:16 -0400 Subject: [PATCH] Improve region map documentation (#13319) --- docs/management/advanced-options.asciidoc | 1 + docs/visualize/regionmap.asciidoc | 6 ++++-- src/core_plugins/kibana/ui_setting_defaults.js | 2 +- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc index eee46a56d3e9c..21be247f18093 100644 --- a/docs/management/advanced-options.asciidoc +++ b/docs/management/advanced-options.asciidoc @@ -52,6 +52,7 @@ when necessary. `visualization:colorMapping`:: Maps values to specified colors within visualizations. `visualization:loadingDelay`:: Time to wait before dimming visualizations during query. `visualization:dimmingOpacity`:: When part of a visualization is highlighted, by hovering over it for example, ths is the opacity applied to the other elements. A higher number means other elements will be less opaque. +`visualization:regionmap:showWarnings`:: Whether the region map show a warning when terms cannot be joined to a shape on the map. `csv:separator`:: A string that serves as the separator for exported values. `csv:quoteValues`:: Set this property to `true` to quote exported values. `history:limit`:: In fields that have history, such as query inputs, the value of this property limits how many recent diff --git a/docs/visualize/regionmap.asciidoc b/docs/visualize/regionmap.asciidoc index f399985eead6e..284fe611d8744 100644 --- a/docs/visualize/regionmap.asciidoc +++ b/docs/visualize/regionmap.asciidoc @@ -26,10 +26,12 @@ Configure a _Terms_ aggregation. The term is the _key_ that is used to join the ==== Options ===== Layer Settings -- *Vector map*: select from a list of vector maps. This list includes the maps that are hosted by the © [Elastic Maps Service](https://www.elastic.co/elastic-maps-service), +- *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 <> 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. +- *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 `vefalse`. ===== Style Settings - *Color Schema*: the color range used to color the shapes. diff --git a/src/core_plugins/kibana/ui_setting_defaults.js b/src/core_plugins/kibana/ui_setting_defaults.js index 804c9ff8444b9..cebba85066ebd 100644 --- a/src/core_plugins/kibana/ui_setting_defaults.js +++ b/src/core_plugins/kibana/ui_setting_defaults.js @@ -137,7 +137,7 @@ export function getUiSettingDefaults() { }, 'visualization:regionmap:showWarnings': { value: true, - description: 'Should the vector map show a warning when terms cannot be joined to a shape on the map.' + description: 'Whether the region map show a warning when terms cannot be joined to a shape on the map.' }, 'visualization:colorMapping': { type: 'json',