[7.5] [DOCS] Consolidates map content (#57736) (#58744)

* [DOCS] Consolidates map content (#57736)

* [DOCS] Consolidates map content

* Section reorganization

* Navigation options

* Added images and cleaned up text

* Added tilemap.html to redirects

* Review comments

* Fixed error

* Fixed region map redirect
This commit is contained in:
Kaarina Tungseth 2020-03-02 12:50:26 -06:00 committed by GitHub
parent d745aa4ee6
commit 8330e1d13a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 137 additions and 92 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 389 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 427 KiB

View file

@ -59,7 +59,7 @@ This page was deleted. See <<xpack-graph>> and <<xpack-ml>>.
[role="exclude",id="xpack-dashboard-only-mode"]
== Dashboard-only mode
Using the `kibana_dashboard_only_user` role is deprecated.
Using the `kibana_dashboard_only_user` role is deprecated.
Use <<kibana-feature-privileges,feature privileges>> instead.
[role="exclude",id="pdf-layout-modes"]
@ -72,4 +72,12 @@ This page has moved. Please see <<reporting-getting-started>>.
This page has moved. Please see <<reporting-getting-started>>.
[role="exclude",id="tilemap"]
== Coordinate map
This page has moved. Please see <<coordinate-map>>.
[role="exclude",id="regionmap"]
== Region map
This page has moved. Please see <<region-map>>.

View file

@ -169,14 +169,14 @@ requests. Supported on {ece}.
Set to false to disable connections to Elastic Maps Service.
When `includeElasticMapsService` is turned off, only the vector layers configured by `map.regionmap`
and the tile layer configured by `map.tilemap.url` will be available in the <<maps, Maps application>>,
<<tilemap, Coordinate map visualizations>>, and <<regionmap, Region map visualizations>>.
<<tilemap, Coordinate map visualizations>>, and <<visualize-maps, Region map visualizations>>.
`map.proxyElasticMapsServiceInMaps:`:: *Default: false*
Set to true to proxy all <<maps, Maps application>> Elastic Maps Service requests through the Kibana server.
This setting does not impact <<tilemap, Coordinate map visualizations>> and <<regionmap, Region map visualizations>>.
This setting does not impact <<tilemap, Coordinate map visualizations>> and <<visualize-maps, Region map visualizations>>.
[[regionmap-settings]] `map.regionmap:`:: Specifies additional vector layers for
use in <<regionmap, Region Map>> visualizations. Supported on {ece}. Each layer
use in <<visualize-maps, Region Map>> visualizations. Supported on {ece}. Each layer
object points to an external vector file that contains a geojson
FeatureCollection. The file must use the
https://en.wikipedia.org/wiki/World_Geodetic_System[WGS84 coordinate reference system]
@ -198,10 +198,10 @@ following example shows a valid regionmap configuration.
description: "INSEE numeric identifier"
--
[[regionmap-ES-map]]`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 {ece}. By turning this off, only the layers that
are configured here will be included. The default is `true`.
[[regionmap-ES-map]]`map.regionmap.includeElasticMapsService:`:: Specifies
the option to include layers from the Elastic Maps Service in the vector
layer option list. Supported on {ece}. When off, only the configured layers are included.
The default is `true`. This option also specifies if the tile-service from the Elastic Maps Service is available.
[[regionmap-attribution]]`map.regionmap.layers[].attribution:`:: Optional.
References the originating source of the geojson file. Supported on {ece}.

View file

@ -45,11 +45,11 @@ data sets.
[horizontal]
<<maps,Elastic Maps>>:: The most powerful way of visualizing map data in {kib}.
<<tilemap,Coordinate map>>:: Displays points on a map using a geohash aggregation.
<<visualize-maps,Coordinate map>>:: Displays points on a map using a geohash aggregation.
<<regionmap,Region map>>:: Merge any structured map data onto a shape.
<<visualize-maps,Region map>>:: Merge any structured map data onto a shape.
<<heatmap,Heat map>>:: Display shaded cells within a matrix.
<<visualize-maps,Heat map>>:: Display shaded cells within a matrix.
* *<<for-dashboard,Dashboard tools>>*
[horizontal]
@ -136,8 +136,6 @@ include::{kib-repo-dir}/visualize/tsvb.asciidoc[]
include::{kib-repo-dir}/visualize/timelion.asciidoc[]
include::{kib-repo-dir}/visualize/tilemap.asciidoc[]
include::{kib-repo-dir}/visualize/regionmap.asciidoc[]
include::{kib-repo-dir}/visualize/heatmap.asciidoc[]
include::{kib-repo-dir}/visualize/for-dashboard.asciidoc[]

View file

@ -1,40 +0,0 @@
[[heatmap]]
== Heat map
Heat maps are graphical representations of data where the individual values are represented as colors.
NOTE: Heat map has been replaced with <<maps>>, which offers more functionality and is easier to use.
[float]
[[heatmap-aggregation]]
=== Supported aggregations
Heat maps support the following aggregations:
* <<visualize-metric-aggregations,Metric>>
* <<visualize-parent-pipeline-aggregations,Parent pipeline>>
* <<visualize-sibling-pipeline-aggregations,Sibling pipeline>>
* <<visualize-bucket-aggregations,Bucket>>
[float]
[[navigate-heatmap]]
=== Change the color ranges
When only one color displays on the heat map, you might need to change the color ranges.
To specify the number of color ranges:
. Click *Options*.
. Enter the *Number of colors* to display.
To specify custom ranges:
. Click *Options*.
. Select *Use custom ranges*.
. Enter the ranges to display.

View file

@ -1,16 +0,0 @@
[[metric-chart]]
=== Metric
Click the *Options* tab to display the font size slider.
[float]
[[metric-aggregation]]
==== Supported aggregations
Metric support the following aggregations:
* <<visualize-metric-aggregations,Metric>>
* <<visualize-sibling-pipeline-aggregations,Sibling pipeline>>
* <<visualize-bucket-aggregations,Bucket>>

View file

@ -1,47 +1,142 @@
[[tilemap]]
== Coordinate map
[[visualize-maps]]
== Maps
Coordinate maps display geographic areas overlaid with circles keyed to the data determined by the buckets you specify. To use coordinate maps, you plot latitude and longitude coordinates.
To tell a story and answer questions about your geographical data, you can create several types of interactive maps with Visualize.
NOTE: Coordinate maps have been replaced with <<maps>>, which offers more functionality and is easier to use.
Visualize supports the following maps:
To create coordinate maps in Visualize:
* *Coordinate* &mdash; Display latitude and longitude coordinates that are associated to the specified bucket aggregation.
* *Region* &mdash; Display colored boundary vector shapes using a gradient. Darker colors indicate larger values, and lighter colors indicate smaller values.
* *Heat* &mdash; Display graphical representations of data where the individual values are represented by colors.
NOTE: The maps in Visualize have been replaced with <<maps>>, which offers more functionality.
[float]
[[coordinate-map]]
=== Coordinate map
Use a coordinate map when your data set includes latitude and longitude values. For example, use a coordinate map to see the varying popularity of destination airports using the sample flight data.
[role="screenshot"]
image::images/visualize_coordinate_map_example.png[]
[float]
[[build-coordinate-map]]
==== Build a coordinate map
Configure the `kibana.yml` settings and add the aggregations.
. Configure the following `kibana.yml` settings:
* Set `xpack.maps.showMapVisualizationTypes` to `true`.
* To display map tiles, {kib} uses the https://www.elastic.co/elastic-maps-service[Elastic Maps Service].
To use other tile service providers, configure the <<tilemap-settings,tilemap settings>>
in `kibana.yml`.
* To use a tile service provider for coordinate maps other than https://www.elastic.co/elastic-maps-service[Elastic Maps Service], configure the <<tilemap-settings,tilemap settings>>.
[float]
[[coordinate-map-aggregation]]
=== Supported aggregations
Coordinate maps support the following aggregations:
. To display your data on the coordinate map, use the following aggregations:
* <<visualize-metric-aggregations,Metric>>
* <<visualize-bucket-aggregations,Geohash Bucket aggregation>>
* <<visualize-bucket-aggregations,Geohash bucket aggregation>>
When you deselect *Change precision on map zoom*, the *Precision* slider appears. The *Precision* slider determines the granularity of the results displayed on the map. For details on the area specified by each precision level, refer to {ref}/search-aggregations-bucket-geohashgrid-aggregation.html#_cell_dimensions_at_the_equator[geohash grid].
. Specify the geohash bucket aggregation options:
* *Precision* slider &mdash; Determines the granularity of the results displayed on the map. To show the *Precision* slider, deselect *Change precision on map zoom*. For information on the area specified by each precision level, refer to {ref}/search-aggregations-bucket-geohashgrid-aggregation.html#_cell_dimensions_at_the_equator[geohash grid].
+
NOTE: Higher precisions increase memory usage for the browser that displays {kib} and the underlying
{es} cluster.
When you select *Place markers off grid (use {ref}/search-aggregations-metrics-geocentroid-aggregation.html[geocentroid])*, the markers are
placed in the center of all documents in the bucket, and a more accurate visualization is created.
* *Place markers off grid (use {ref}/search-aggregations-metrics-geocentroid-aggregation.html[geocentroid])* &mdash; When you selected, the markers are
placed in the center of all documents in the bucket, and a more accurate visualization is created. When deselected, the markers are placed in the center
of the geohash grid cell.
+
NOTE: When you have multiple values in the geo_point, the coordinate map is unable to accurately calculate the geo_centroid.
When you deselect *Place markers off grid (use {ref}/search-aggregations-metrics-geocentroid-aggregation.html[geocentroid])*, the markers are placed in the center
of the geohash grid cell.
[float]
[[navigate-map]]
=== Navigate the coordinate map
[[navigate-coordinate-map]]
==== Navigate the coordinate map
Use the following navigation options:
To navigate the coordinate map, use the navigation options.
* To move the map center, click and hold anywhere on the map and move the cursor.
* To change the zoom level, click *Zoom In* or *Zoom out* image:images/viz-zoom.png[].
* To automatically crop the map boundaries to the
geohash buckets that have at least one result, click *Fit Data Bounds* image:images/viz-fit-bounds.png[].
[float]
[[region-map]]
=== Region map
Use region maps when you want to show statistical data on a geographic area, such as a county, country, province, or state. For example, use a region map if you want to see the average sales for each country with the sample eCommerce order data.
[role="screenshot"]
image::images/visualize_region_map_example.png[]
[float]
[[build-region-maps]]
==== Build a region map
Configure the `kibana.yml` settings and add the aggregations.
. In `kibana.yml`, set `xpack.maps.showMapVisualizationTypes` to `true`.
. To display your data on the region map, use the following aggregations:
* <<visualize-metric-aggregations,Metric>>
* <<visualize-sibling-pipeline-aggregations,Sibling pipeline>>
* <<visualize-bucket-aggregations,Terms bucket aggregation>>
[float]
[[navigate-region-map]]
==== Navigate the region map
To navigate the region map, use the navigation options.
* To change the zoom level, click *Zoom In* or *Zoom out* image:images/viz-zoom.png[].
* To automatically crop the map boundaries, click *Fit Data Bounds* image:images/viz-fit-bounds.png[].
[float]
[[heat-map]]
=== Heat map
Use heat maps when your data set includes categorical data. For example, use a heat map to see the flights of origin countries compared to destination countries using the sample flight data.
[role="screenshot"]
image::images/visualize_heat_map_example.png[]
[float]
[[build-heat-map]]
==== Build a heat map
To display your data on the heat map, use the supported aggregations.
Heat maps support the following aggregations:
* <<visualize-metric-aggregations,Metric>>
* <<visualize-parent-pipeline-aggregations,Parent pipeline>>
* <<visualize-sibling-pipeline-aggregations,Sibling pipeline>>
* <<visualize-bucket-aggregations,Bucket>>
[float]
[[navigate-heatmap]]
==== Change the color ranges
When only one color displays on the heat map, you might need to change the color ranges.
To specify the number of color ranges:
. Click *Options*.
. Enter the *Number of colors* to display.
To specify custom ranges:
. Click *Options*.
. Select *Use custom ranges*.
. Enter the ranges to display.