kibana/docs/maps/vector-layer.asciidoc
Nathan Reese 75f8ac424e
[Maps] Add support for geohex_grid aggregation (#127170)
* [Maps] hex bin gridding

* remove console.log

* disable hexbins for license and geo_shape

* fix jest tests

* copy cleanup

* label

* update clusters SVG with hexbins

* show as tooltip

* documenation updates

* copy updates

* add API test for hex

* test cleanup

* eslint

* eslint and functional test fixes

* eslint, copy updates, and more doc updates

* fix i18n error

* consolidate isMvt logic

* copy review feedback

* use 3 stop scale for hexs

* jest snapshot updates

* Update x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/es_geo_grid_source.tsx

Co-authored-by: Nick Peihl <nickpeihl@gmail.com>

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Nick Peihl <nickpeihl@gmail.com>
2022-03-23 08:20:10 -06:00

53 lines
2.8 KiB
Text

[role="xpack"]
[[vector-layer]]
== Vector layer
Vector layers display points, lines, and polygons.
[role="screenshot"]
image::maps/images/vector_layer.png[]
To add a vector layer to your map, click *Add layer*, then select one of the following:
*Choropleth*:: Shaded areas to compare statistics across boundaries.
*Clusters*:: Geospatial data grouped in grids with metrics for each gridded cell.
The index must contain at least one field mapped as {ref}/geo-point.html[geo_point] or {ref}/geo-shape.html[geo_shape].
*Create index*:: Draw shapes on the map and index in Elasticsearch.
*Documents*:: Points, lines, and polyons from Elasticsearch.
The index must contain at least one field mapped as {ref}/geo-point.html[geo_point] or {ref}/geo-shape.html[geo_shape].
+
Results are limited to the `index.max_result_window` index setting, which defaults to 10000.
Select the appropriate *Scaling* option for your use case.
+
* *Limit results to 10,000* The layer displays features from the first `index.max_result_window` documents.
Results exceeding `index.max_result_window` are not displayed.
* *Show clusters when results exceed 10,000* When results exceed `index.max_result_window`, the layer uses {ref}/search-aggregations-bucket-geotilegrid-aggregation.html[GeoTile grid aggregation] to group your documents into clusters and displays metrics for each cluster. When results are less then `index.max_result_window`, the layer displays features from individual documents.
* *Use vector tiles.* Vector tiles partition your map into tiles.
Each tile request is limited to the `index.max_result_window` index setting.
When a tile exceeds `index.max_result_window`, results exceeding `index.max_result_window` are not contained in the tile and a dashed rectangle outlining the bounding box containing all geo values within the tile is displayed.
*EMS Boundaries*:: Administrative boundaries from https://www.elastic.co/elastic-maps-service[Elastic Maps Service].
*ML Anomalies*:: Points and lines associated with anomalies. The {anomaly-job}
must use a `lat_long` function. Go to
{ml-docs}/geographic-anomalies.html[Detecting anomalous locations in geographic data] for an example.
*Point to point*:: Aggregated data paths between the source and destination.
The index must contain at least 2 fields mapped as {ref}/geo-point.html[geo_point], source and destination.
*Top hits per entity*:: The layer displays the <<maps-top-hits-aggregation, most relevant documents per entity>>.
The index must contain at least one field mapped as {ref}/geo-point.html[geo_point] or {ref}/geo-shape.html[geo_shape].
*Tracks*:: Create lines from points.
The index must contain at least one field mapped as {ref}/geo-point.html[geo_point].
*Upload Geojson*:: Index GeoJSON data in Elasticsearch.
include::vector-style.asciidoc[]
include::vector-style-properties.asciidoc[]
include::vector-tooltips.asciidoc[]