diff --git a/docs/images/tutorial-visualize-map-2.png b/docs/images/tutorial-visualize-map-2.png index 8b903f59e970..08464b55ee6c 100644 Binary files a/docs/images/tutorial-visualize-map-2.png and b/docs/images/tutorial-visualize-map-2.png differ diff --git a/docs/images/tutorial-visualize-map-3.png b/docs/images/tutorial-visualize-map-3.png index e21b643b8179..c0c47c7eac3f 100644 Binary files a/docs/images/tutorial-visualize-map-3.png and b/docs/images/tutorial-visualize-map-3.png differ diff --git a/docs/visualize/tilemap.asciidoc b/docs/visualize/tilemap.asciidoc index cbb52d01a340..36111e891cae 100644 --- a/docs/visualize/tilemap.asciidoc +++ b/docs/visualize/tilemap.asciidoc @@ -7,6 +7,12 @@ NOTE: By default, Kibana uses the https://www.elastic.co/elastic-tile-service[El to display map tiles. To use other tile service providers, configure the <> in `kibana.yml`. +=== Configuration + +==== Data + +===== Metrics + The default _metrics_ aggregation for a tile map is the *Count* aggregation. You can select any of the following aggregations as the metrics aggregation: @@ -25,57 +31,24 @@ the number of unique values in a field. Select a field from the drop-down. Enter a string in the *Custom Label* field to change the display label. -The _buckets_ aggregations determine what information is being retrieved from your data set. +===== Buckets -Before you choose a buckets aggregation, specify if you are splitting the chart or displaying the buckets as *Geo -Coordinates* on a single chart. A multiple chart split must run before any other aggregations. -Tile maps use the *Geohash* aggregation as their initial aggregation. Select a field, typically coordinates, from the -drop-down. The *Precision* slider determines the granularity of the results displayed on the map. See the documentation +Tile maps uses the {es-ref}search-aggregations-bucket-geohashgrid-aggregation.html[_geohash_] aggregation. Select a field, typically coordinates, from the +drop-down. + +- The_Change precision on map zoom_ box is checked by default. Uncheck the box to disable this behavior. +The _Precision_ slider determines the granularity of the results displayed on the map. See the documentation for the {es-ref}search-aggregations-bucket-geohashgrid-aggregation.html#_cell_dimensions_at_the_equator[geohash grid] -aggregation for details on the area specified by each precision level. Kibana supports a maximum geohash length of 7. +aggregation for details on the area specified by each precision level. NOTE: Higher precisions increase memory usage for the browser displaying Kibana as well as for the underlying Elasticsearch cluster. -Once you've specified a buckets aggregation, you can define sub-aggregations to refine the visualization. Tile maps -only support sub-aggregations as split charts. Click *+ Add Sub Aggregation*, then *Split Chart* to select a -sub-aggregation from the list of types: +- The _place markers off grid (use {es-ref}search-aggregations-metrics-geocentroid-aggregation.html[geocentroid])_ box is checked by default. When this box is checked, the markers are +placed in the center of all the documents in that bucket. When unchecked, the markers are placed in the center +of the geohash grid cell. Leaving this checked generally results in a more accurate visualization. -*Date Histogram*:: A {es-ref}search-aggregations-bucket-datehistogram-aggregation.html[_date histogram_] is built from a -numeric field and organized by date. You can specify a time frame for the intervals in seconds, minutes, hours, days, -weeks, months, or years. You can also specify a custom interval frame by selecting *Custom* as the interval and -specifying a number and a time unit in the text field. Custom interval time units are *s* for seconds, *m* for minutes, -*h* for hours, *d* for days, *w* for weeks, and *y* for years. Different units support different levels of precision, -down to one second. -*Histogram*:: A standard {es-ref}search-aggregations-bucket-histogram-aggregation.html[_histogram_] is built from a -numeric field. Specify an integer interval for this field. Select the *Show empty buckets* checkbox to include empty -intervals in the histogram. -*Range*:: With a {es-ref}search-aggregations-bucket-range-aggregation.html[_range_] aggregation, you can specify ranges -of values for a numeric field. Click *Add Range* to add a set of range endpoints. Click the red *(x)* symbol to remove -a range. -After changing options, click the *Apply changes* button to update your visualization, or the grey *Discard -changes* button to keep your visualization in its current state. -*Date Range*:: A {es-ref}search-aggregations-bucket-daterange-aggregation.html[_date range_] aggregation reports values -that are within a range of dates that you specify. You can specify the ranges for the dates using -{es-ref}common-options.html#date-math[_date math_] expressions. Click *Add Range* to add a set of range endpoints. -Click the red *(/)* symbol to remove a range. -*IPv4 Range*:: The {es-ref}search-aggregations-bucket-iprange-aggregation.html[_IPv4 range_] aggregation enables you to -specify ranges of IPv4 addresses. Click *Add Range* to add a set of range endpoints. Click the red *(/)* symbol to -remove a range. -*Terms*:: A {es-ref}search-aggregations-bucket-terms-aggregation.html[_terms_] aggregation enables you to specify the top -or bottom _n_ elements of a given field to display, ordered by count or a custom metric. -*Filters*:: You can specify a set of {es-ref}search-aggregations-bucket-filters-aggregation.html[_filters_] for the data. -You can specify a filter as a query string or in JSON format, just as in the Discover search bar. Click *Add Filter* to -add another filter. Click the image:images/labelbutton.png[] *label* button to open the label field, where you can type -in a name to display on the visualization. -*Significant Terms*:: Displays the results of the experimental -{es-ref}search-aggregations-bucket-significantterms-aggregation.html[_significant terms_] aggregation. The value of the -*Size* parameter defines the number of entries this aggregation returns. -*Geohash*:: The {es-ref}search-aggregations-bucket-geohashgrid-aggregation.html[_geohash_] aggregation displays points -based on the geohash coordinates. - -NOTE: By default, the *Change precision on map zoom* box is checked. Uncheck the box to disable this behavior. Enter a string in the *Custom Label* field to change the display label. @@ -94,7 +67,8 @@ NOTE: In Elasticsearch releases 1.4.3 and later, this functionality requires you The availability of these options varies depending on the aggregation you choose. -Select the *Options* tab to change the following aspects of the chart: +==== Options + *Map type*:: Select one of the following options from the drop-down. *_Scaled Circle Markers_*:: Scale the size of the markers based on the metric aggregation's value. @@ -130,7 +104,9 @@ changes* button to keep your visualization in its current state. [float] [[navigating-map]] -==== Navigating the Map + +=== Navigating the Map + Once your tilemap visualization is ready, you can explore the map in several ways: * Click and hold anywhere on the map and move the cursor to move the map center. Hold Shift and drag a bounding box @@ -143,6 +119,7 @@ map, to create a filter for the box coordinates. [float] [[tilemap-viewing-detailed-information]] -==== Viewing Detailed Information + +=== Viewing Detailed Information include::visualization-raw-data.asciidoc[]