kibana/docs/maps/vector-layer.asciidoc
Thomas Neirynck 33fd1bdff0
[Maps] Use ES mvt (#114553)
* tmp

* tmp

* tmp

* tmp

* tmp

* use es naming

* typo

* organize files for clarity

* plugin for hits

* tmp

* initial styling

* more boilerplate

* tmp

* temp

* add size support

* remove junk

* tooltip

* edits

* too many features

* rename for clarity

* typing

* tooltip improvements

* icon

* callouts

* align count handling

* typechecks

* i18n

* tmp

* type fixes

* linting

* convert to ts and disable option

* readd test dependencies

* typescheck

* update yarn lock

* fix typecheck

* update snapshot

* fix snapshot

* fix snapshot

* fix snapshot

* fix snapshot

* fix test

* fix tests

* fix test

* add key

* fix integration test

* move test

* use centroid placement

* more text fixes

* more test fixes

* Remove top terms aggregations when switching to super fine resolution (#114667)

* [Maps] MVT metrics

* remove js file

* updateSourceProps

* i18n cleanup

* mvt labels

* remove isPointsOnly from IVectorSource interface

* move get_centroid_featues to vector_layer since its no longer used in server

* labels

* warn users when selecting scaling type that does not support term joins

* clean up scaling_form

* remove IField.isCountable method

* move pluck code from common to dynamic_style_property

* move convert_to_geojson to es_geo_grid_source folder

* remove getMbFeatureIdPropertyName from IVectorLayer

* clean up cleanTooltipStateForLayer

* use euiWarningColor for too many features outline

* update jest snapshots and eslint fixes

* update docs for incomplete data changes

* move tooManyFeatures MB layer definition from VectorLayer to TiledVectorLayer, clean up VectorSource interface

* remove commented out filter in tooltip_control add api docs for getMbLayerIds and getMbTooltipLayerIds

* revert changing getSourceTooltipContent to getSourceTooltipConfigFromGeoJson

* replace DEFAULT_MAX_RESULT_WINDOW with loading maxResultWindow as data request

* clean up

* eslint

* remove unused constants from Kibana MVT implemenation and tooManyFeaturesImage

* add better should method for tiled_vector_layer.getCustomIconAndTooltipContent jest test

* fix tooltips not being displayed for super-fine clusters and grids

* fix check in getFeatureId for es_Search_sources only

* eslint, remove __kbn_metadata_feature__ filter from mapbox style expects

* remove geoFieldType paramter for tile API

* remove searchSessionId from MVT url since its no longer used

* tslint

* vector tile scaling option copy update

* fix getTile and getGridTile API integration tests

* remove size from _mvt request body, size provided in query

* eslint, fix test expect

* stablize jest test

* track total hits for _mvt request

* track total hits take 2

* align vector tile copy

* eslint

* revert change to EsSearchSource._loadTooltipProperties with regards to handling undefined _index. MVT now provides _index

* clean up

* only send metric aggregations to mvt/getGridTile endpoint

* update snapshot, update getGridTile URLs in tests

* update request URL for getGridTile

* eslint

Co-authored-by: Nathan Reese <reese.nathan@gmail.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-10-25 10:41:04 -06:00

49 lines
2.6 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 and grids*:: 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].
*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[]