Map settings in Kibana

General map settings

map.regionmap

Supported on: Elastic Cloud Hosted lets you manage and configure one or more deployments of the versioned Elastic Stack, hosted on Elastic Cloud. Availability Generally available This functionality is generally available and ready for production usage. Self-managed deployments are Elastic Stack deployments managed without the assistance of an orchestrator. Availability Generally available This functionality is generally available and ready for production usage. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Specifies additional vector layers for use in Region Map visualizations. Each layer object points to an external vector file that contains a geojson FeatureCollection. The file must use the 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.

Datatype: string

The following example shows a valid regionmap configuration.

map.regionmap:
  includeElasticMapsService: false
  layers:
    - name: "Departments of France"
      url: "<MY_CORS_ENABLED_SERVER_URL>/france_departements.geojson"
      attribution: "INRAP"
      fields:
        - name: "department"
          description: "Full department name"
        - name: "INSEE"
          description: "INSEE numeric identifier"

map.regionmap.includeElasticMapsService

Turns on or off whether layers from the Elastic Maps Service should be included in the vector layer option list. Supported on Elastic Cloud Enterprise. By turning this off, only the layers that are configured here will be included.

Datatype: bool

Default: true

map.regionmap.layers[].attribution

Optional. References the originating source of the geojson file.

Datatype: string

map.regionmap.layers[].fields[]

Mandatory. Each layer can contain multiple fields to indicate what properties from the geojson features you wish to expose. The previous example shows how to define multiple properties.

Datatype: string

map.regionmap.layers[].fields[].description

Mandatory. The human readable text that is shown under the Options tab when building the Region Map visualization.

Datatype: string

map.regionmap.layers[].fields[].name

Mandatory. This value is used to do an inner-join between the document stored in Elasticsearch and the geojson file. For example, 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.

Datatype: string

map.regionmap.layers[].name

Mandatory. A description of the map being provided.

Datatype: string

map.regionmap.layers[].url

Mandatory. The location of the geojson file as provided by a webserver.

Datatype: string

map.tilemap.options.attribution

Sets the map attribution string. Attribution must be a list of links, delimited by \|. For example: "[attribution 1](https://www.attribution1)\|[attribution 2](https://www.attribution2)"

Datatype: string

map.tilemap.options.maxZoom

Sets the maximum zoom level.

Datatype: int

Default: 10

map.tilemap.options.minZoom

Sets the minimum zoom level.

Datatype: int

Default: 0

map.tilemap.options.subdomains

Provides an array of subdomains used by the tile service. Specify the position of the subdomain the URL with the token {s}.

Datatype: string

map.tilemap.url

Sets the URL to the tileservice that Kibana uses to display map tiles in tilemap visualizations.

Datatype: string