diff --git a/docs/setup/settings.asciidoc b/docs/setup/settings.asciidoc index 6e5a56d8ae1097a..e77fa4f6f51322e 100644 --- a/docs/setup/settings.asciidoc +++ b/docs/setup/settings.asciidoc @@ -81,13 +81,10 @@ 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: + includeElasticMapsService: false layers: - name: "Departments of France" url: "http://my.cors.enabled.server.org/france_departements.geojson" @@ -98,8 +95,15 @@ 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.includeElasticMapsService`:: turns on or off whether layers from the Elastic Maps Service should be included in the vector layer option list. -By turning this off, only the layers that are configured here will be included. +By turning this off, only the layers that are configured here will be included. The default is true. `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