From a8af47944d0edea932f94687390b69a2432aca0c Mon Sep 17 00:00:00 2001 From: markwalkom Date: Thu, 16 Nov 2017 01:42:20 +1100 Subject: [PATCH 1/2] Region map settings clarifications (#14893) Improve documentation --- docs/setup/settings.asciidoc | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/setup/settings.asciidoc b/docs/setup/settings.asciidoc index 9748a70be5ddea..8ca776aa11b969 100644 --- a/docs/setup/settings.asciidoc +++ b/docs/setup/settings.asciidoc @@ -81,10 +81,6 @@ The minimum value is 100. Each layer object points to an external vector file that contains a geojson FeatureCollection. The file must use the [WGS84 coordinate reference system](https://en.wikipedia.org/wiki/World_Geodetic_System) and only include polygons. If the file is hosted on a separate domain from Kibana, the server needs to be CORS-enabled so Kibana can download the file. -The url field also serves as a unique identifier for the file. -Each layer can contain multiple fields to indicate what properties from the geojson features you want to expose. -The field.description is the human readable text that is shown in the Region Map visualization's field menu. -An optional attribution value can be added as well. The following example shows a valid regionmap configuration. regionmap: @@ -97,6 +93,13 @@ The following example shows a valid regionmap configuration. description: "Full department name" - name: "INSEE" description: "INSEE numeric identifier" + +`name:`:: Mandatory. A description of the map being provided. +`url:`:: Mandatory. The location of the geojson file as provided by a webserver. +`attribution:`:: Optional. References the originating source of the geojson file. +`fields:`:: Mandatory. Each layer can contain multiple fields to indicate what properties from the geojson features you wish to expose. The example above shows how to define multiple properties. +`fields.name:`:: Mandatory. This value is used to do an inner-join between the document stored in Elasticsearch and the geojson file. e.g. if the field in the geojson is called `Location` and has city names, there must be a field in Elasticsearch that holds the same values that Kibana can then use to lookup for the geoshape data. +`fields.description:`:: Mandatory. The human readable text that is shown under the Options tab when building the Region Map visualization. `server.basePath:`:: Enables you to specify a path to mount Kibana at if you are running behind a proxy. This only affects the URLs generated by Kibana, your proxy is expected to remove the basePath value before forwarding requests From 5e7c3e01f0ea29b6976220eb13b001ca9767a072 Mon Sep 17 00:00:00 2001 From: Thomas Neirynck Date: Tue, 5 Dec 2017 15:09:43 -0500 Subject: [PATCH 2/2] use fully qualified paths --- docs/setup/settings.asciidoc | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/setup/settings.asciidoc b/docs/setup/settings.asciidoc index 8ca776aa11b969..f0e4b143f354a9 100644 --- a/docs/setup/settings.asciidoc +++ b/docs/setup/settings.asciidoc @@ -79,11 +79,11 @@ The minimum value is 100. [[regionmap-settings]] `regionmap`:: Specifies additional vector layers for use in <> visualizations. Each layer object points to an external vector file that contains a geojson FeatureCollection. -The file must use the [WGS84 coordinate reference system](https://en.wikipedia.org/wiki/World_Geodetic_System) and only include polygons. +The file must use the https://en.wikipedia.org/wiki/World_Geodetic_System[WGS84 coordinate reference system] and only include polygons. If the file is hosted on a separate domain from Kibana, the server needs to be CORS-enabled so Kibana can download the file. The following example shows a valid regionmap configuration. - regionmap: + regionmap: layers: - name: "Departments of France" url: "http://my.cors.enabled.server.org/france_departements.geojson" @@ -94,12 +94,12 @@ The following example shows a valid regionmap configuration. - name: "INSEE" description: "INSEE numeric identifier" -`name:`:: Mandatory. A description of the map being provided. -`url:`:: Mandatory. The location of the geojson file as provided by a webserver. -`attribution:`:: Optional. References the originating source of the geojson file. -`fields:`:: Mandatory. Each layer can contain multiple fields to indicate what properties from the geojson features you wish to expose. The example above shows how to define multiple properties. -`fields.name:`:: Mandatory. This value is used to do an inner-join between the document stored in Elasticsearch and the geojson file. e.g. if the field in the geojson is called `Location` and has city names, there must be a field in Elasticsearch that holds the same values that Kibana can then use to lookup for the geoshape data. -`fields.description:`:: Mandatory. The human readable text that is shown under the Options tab when building the Region Map visualization. +`regionmap.layers[].name:`:: Mandatory. A description of the map being provided. +`regionmap.layers[].url:`:: Mandatory. The location of the geojson file as provided by a webserver. +`regionmap.layers[].attribution:`:: Optional. References the originating source of the geojson file. +`regionmap.layers[].fields[]:`:: Mandatory. Each layer can contain multiple fields to indicate what properties from the geojson features you wish to expose. The example above shows how to define multiple properties. +`regionmap.layers[].fields[].name:`:: Mandatory. This value is used to do an inner-join between the document stored in Elasticsearch and the geojson file. e.g. if the field in the geojson is called `Location` and has city names, there must be a field in Elasticsearch that holds the same values that Kibana can then use to lookup for the geoshape data. +`regionmap.layers[].fields[].description:`:: Mandatory. The human readable text that is shown under the Options tab when building the Region Map visualization. `server.basePath:`:: Enables you to specify a path to mount Kibana at if you are running behind a proxy. This only affects the URLs generated by Kibana, your proxy is expected to remove the basePath value before forwarding requests