Skip to content

Commit ed66d1d

Browse files
KOTungsethKOTungseth
authored
[DOCS] Adds geocentroid note to coordinate map (#54389) (#55101)
* [DOCS] Added note to coordinate map for geocentroid * Minor changes * Comments from Gail
1 parent 922117d commit ed66d1d

File tree

1 file changed

+49
-79
lines changed

1 file changed

+49
-79
lines changed

‎docs/visualize/tilemap.asciidoc‎

Lines changed: 49 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,72 @@
11
[[tilemap]]
2-
== Coordinate Maps
2+
== Coordinate map
33

4-
A coordinate map displays a geographic area overlaid with circles keyed to the data determined by the buckets you specify.
4+
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.
55

6-
NOTE: By default, Kibana uses the https://www.elastic.co/elastic-maps-service[Elastic Maps Service]
7-
to display map tiles. To use other tile service providers, configure the <<tilemap-settings,tilemap settings>>
6+
NOTE: Coordinate maps have been replaced with <<maps>>, which offers more functionality and is easier to use.
7+
8+
To create coordinate maps in Visualize:
9+
10+
* Set `xpack.maps.showMapVisualizationTypes` to `true`.
11+
12+
* To display map tiles, {kib} uses the https://www.elastic.co/elastic-maps-service[Elastic Maps Service].
13+
To use other tile service providers, configure the <<tilemap-settings,tilemap settings>>
814
in `kibana.yml`.
915

1016
[float]
11-
[[tilemap-configuration]]
12-
=== Configuration
17+
[[coordinate-map-aggregation]]
18+
=== Supported aggregations
1319

14-
[float]
15-
==== Data
20+
Coordinate maps support the metric and bucket aggregations.
1621

1722
[float]
18-
===== Metrics
19-
20-
The default _metrics_ aggregation for a coordinate map is the *Count* aggregation. You can select any of the following
21-
aggregations as the metrics aggregation:
22-
23-
*Count*:: The {ref}/search-aggregations-metrics-valuecount-aggregation.html[_count_] aggregation returns a raw count of
24-
the elements in the selected index pattern.
25-
*Average*:: This aggregation returns the {ref}/search-aggregations-metrics-avg-aggregation.html[_average_] of a numeric
26-
field. Select a field from the drop-down.
27-
*Sum*:: The {ref}/search-aggregations-metrics-sum-aggregation.html[_sum_] aggregation returns the total sum of a numeric
28-
field. Select a field from the drop-down.
29-
*Min*:: The {ref}/search-aggregations-metrics-min-aggregation.html[_min_] aggregation returns the minimum value of a
30-
numeric field. Select a field from the drop-down.
31-
*Max*:: The {ref}/search-aggregations-metrics-max-aggregation.html[_max_] aggregation returns the maximum value of a
32-
numeric field. Select a field from the drop-down.
33-
*Unique Count*:: The {ref}/search-aggregations-metrics-cardinality-aggregation.html[_cardinality_] aggregation returns
34-
the number of unique values in a field. Select a field from the drop-down.
35-
36-
Enter a string in the *Custom Label* field to change the display label.
23+
===== Metric aggregations
3724

38-
[float]
39-
===== Buckets
25+
The following metric aggregations are supported:
4026

41-
Coordinate maps use the {ref}/search-aggregations-bucket-geohashgrid-aggregation.html[_geohash_] aggregation. Select a field, typically coordinates, from the
42-
drop-down.
27+
{ref}/search-aggregations-metrics-valuecount-aggregation.html[Count]:: Returns a raw count of
28+
the elements in the index pattern. The default metrics aggregation for a coordinate map is *Count*.
4329

44-
- The _Change precision on map zoom_ box is checked by default. Uncheck the box to disable this behavior.
45-
The _Precision_ slider determines the granularity of the results displayed on the map. See the documentation
46-
for the {ref}/search-aggregations-bucket-geohashgrid-aggregation.html#_cell_dimensions_at_the_equator[geohash grid]
47-
aggregation for details on the area specified by each precision level.
30+
{ref}/search-aggregations-metrics-avg-aggregation.html[Average]:: Returns the average of a numeric
31+
field.
4832

49-
NOTE: Higher precisions increase memory usage for the browser displaying Kibana as well as for the underlying
50-
Elasticsearch cluster.
33+
{ref}/search-aggregations-metrics-sum-aggregation.html[Sum]:: Returns the total sum of a numeric
34+
field.
5135

52-
- The _place markers off grid (use {ref}/search-aggregations-metrics-geocentroid-aggregation.html[geocentroid])_ box is checked by default. When this box is checked, the markers are
53-
placed in the center of all the documents in that bucket. When unchecked, the markers are placed in the center
54-
of the geohash grid cell. Leaving this checked generally results in a more accurate visualization.
36+
{ref}/search-aggregations-metrics-min-aggregation.html[Min]:: Returns the minimum value of a
37+
numeric field.
5538

39+
{ref}/search-aggregations-metrics-max-aggregation.html[Max]:: Returns the maximum value of a
40+
numeric field.
5641

57-
Enter a string in the *Custom Label* field to change the display label.
42+
{ref}/search-aggregations-metrics-cardinality-aggregation.html[Unique Count]:: Returns
43+
the number of unique values in a field.
5844

5945
[float]
60-
==== Options
61-
62-
*Map type*:: Select one of the following options from the drop-down.
63-
*_Scaled Circle Markers_*:: Scale the size of the markers based on the metric aggregation's value.
64-
*_Shaded Circle Markers_*:: Displays the markers with different shades based on the metric aggregation's value.
65-
*_Shaded Geohash Grid_*:: Displays the rectangular cells of the geohash grid instead of circular markers, with different
66-
shades based on the metric aggregation's value.
67-
*_Heatmap_*:: A heat map applies blurring to the circle markers and applies shading based on the amount of overlap.
68-
Heatmaps have the following options:
69-
70-
* *Cluster size*: Adjust the size of the heatmap clustering.
71-
* *Show Tooltip*: Check this box to have a tooltip with the values for a given dot when the cursor is on that dot.
72-
73-
*Desaturate map tiles*:: Desaturate the map's color in order to make the markers stand out more clearly.
74-
*WMS compliant map server*:: Check this box to enable the use of a third-party mapping service that complies with the Web
75-
Map Service (WMS) standard. Specify the following elements:
76-
77-
* *WMS url*: The URL for the WMS map service.
78-
* *WMS layers*: A comma-separated list of the layers to use in this visualization. Each map server provides its own list of
79-
layers.
80-
* *WMS version*: The WMS version used by this map service.
81-
* *WMS format*: The image format used by this map service. The two most common formats are `image/png` and `image/jpeg`.
82-
* *WMS attribution*: An optional, user-defined string that identifies the map source. Maps display the attribution string
83-
in the lower right corner.
84-
* *WMS styles*: A comma-separated list of the styles to use in this visualization. Each map server provides its own styling
85-
options.
86-
87-
After changing options, click the *Apply changes* button to update your visualization, or the grey *Discard
88-
changes* button to keep your visualization in its current state.
46+
[[coordinate-bucket-aggregation]]
47+
===== Bucket aggregation
48+
49+
Coordinate maps support the {ref}/search-aggregations-bucket-geohashgrid-aggregation.html[_geohash_] bucket aggregation.
50+
51+
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].
52+
53+
NOTE: Higher precisions increase memory usage for the browser that displays {kib} and the underlying
54+
{es} cluster.
55+
56+
When you select *Place markers off grid (use {ref}/search-aggregations-metrics-geocentroid-aggregation.html[geocentroid])*, the markers are
57+
placed in the center of all documents in the bucket, and a more accurate visualization is created.
58+
NOTE: When you have multiple values in the geo_point, the coordinate map is unable to accurately calculate the geo_centroid.
59+
60+
When you deselect *Place markers off grid (use {ref}/search-aggregations-metrics-geocentroid-aggregation.html[geocentroid])*, the markers are placed in the center
61+
of the geohash grid cell.
8962

9063
[float]
9164
[[navigate-map]]
92-
=== Navigating the Map
65+
=== Navigate the coordinate map
9366

94-
Once your tilemap visualization is ready, you can explore the map in several ways:
67+
Use the following navigation options:
9568

96-
* Click and hold anywhere on the map and move the cursor to move the map center. Hold Shift and drag a bounding box
97-
across the map to zoom in on the selection.
98-
* Click the *Zoom In/Out* image:images/viz-zoom.png[] buttons to change the zoom level manually.
99-
* Click the *Fit Data Bounds* image:images/viz-fit-bounds.png[] button to automatically crop the map boundaries to the
100-
geohash buckets that have at least one result.
101-
* Click the *Latitude/Longitude Filter* image:images/viz-lat-long-filter.png[] button, then drag a bounding box across the
102-
map, to create a filter for the box coordinates.
69+
* To move the map center, click and hold anywhere on the map and move the cursor.
70+
* To change the zoom level, click *Zoom In* or *Zoom out* image:images/viz-zoom.png[].
71+
* To automatically crop the map boundaries to the
72+
geohash buckets that have at least one result, click *Fit Data Bounds* image:images/viz-fit-bounds.png[].

0 commit comments

Comments
 (0)