You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: specification/_global/search_mvt/SearchMvtRequest.ts
+2-48Lines changed: 2 additions & 48 deletions
Original file line number
Diff line number
Diff line change
@@ -44,54 +44,6 @@ import { ZoomLevel } from './_types/ZoomLevel'
44
44
* * Optionally, a `geo_bounds` aggregation on the `<field>`. The search only includes this aggregation if the `exact_bounds` parameter is `true`.
45
45
* * If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.
46
46
*
47
-
* For example, Elasticsearch may translate a vector tile search API request with a `grid_agg` argument of `geotile` and an `exact_bounds` argument of `true` into the following search
48
-
*
49
-
* ```
50
-
* GET my-index/_search
51
-
* {
52
-
* "size": 10000,
53
-
* "query": {
54
-
* "geo_bounding_box": {
55
-
* "my-geo-field": {
56
-
* "top_left": {
57
-
* "lat": -40.979898069620134,
58
-
* "lon": -45
59
-
* },
60
-
* "bottom_right": {
61
-
* "lat": -66.51326044311186,
62
-
* "lon": 0
63
-
* }
64
-
* }
65
-
* }
66
-
* },
67
-
* "aggregations": {
68
-
* "grid": {
69
-
* "geotile_grid": {
70
-
* "field": "my-geo-field",
71
-
* "precision": 11,
72
-
* "size": 65536,
73
-
* "bounds": {
74
-
* "top_left": {
75
-
* "lat": -40.979898069620134,
76
-
* "lon": -45
77
-
* },
78
-
* "bottom_right": {
79
-
* "lat": -66.51326044311186,
80
-
* "lon": 0
81
-
* }
82
-
* }
83
-
* }
84
-
* },
85
-
* "bounds": {
86
-
* "geo_bounds": {
87
-
* "field": "my-geo-field",
88
-
* "wrap_longitude": false
89
-
* }
90
-
* }
91
-
* }
92
-
* }
93
-
* ```
94
-
*
95
47
* The API returns results as a binary Mapbox vector tile.
96
48
* Mapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:
97
49
*
@@ -166,6 +118,8 @@ import { ZoomLevel } from './_types/ZoomLevel'
166
118
* Some cells may intersect more than one vector tile.
167
119
* To compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.
168
120
* Elasticsearch uses the H3 resolution that is closest to the corresponding geotile density.
121
+
*
122
+
* Learn how to use the vector tile search API with practical examples in the [Vector tile search examples](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search) guide.
0 commit comments