[DOCS] Update info about geo_shape bounding boxes (#61214) (#61216)

* Adding information about geo_shape bounding boxes.

* Fixing cross link and incorporating review feedback.
This commit is contained in:
Adam Locke 2020-08-17 11:44:46 -04:00 committed by GitHub
parent 60876a0e32
commit a3f357c8a5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 2 deletions

View File

@ -3,7 +3,6 @@
A metric aggregation that computes the bounding box containing all geo values for a field. A metric aggregation that computes the bounding box containing all geo values for a field.
Example: Example:
[source,console] [source,console]
@ -50,7 +49,7 @@ POST /museums/_search?size=0
-------------------------------------------------- --------------------------------------------------
<1> The `geo_bounds` aggregation specifies the field to use to obtain the bounds. <1> The `geo_bounds` aggregation specifies the field to use to obtain the bounds.
<2> `wrap_longitude` is an optional parameter which specifies whether the bounding box should be allowed to overlap the international date line. The default value is `true`. <2> [[geo-bounds-wrap-longitude]] `wrap_longitude` is an optional parameter which specifies whether the bounding box should be allowed to overlap the international date line. The default value is `true`.
The above aggregation demonstrates how one would compute the bounding box of the location field for all documents with a business type of shop The above aggregation demonstrates how one would compute the bounding box of the location field for all documents with a business type of shop
@ -84,6 +83,17 @@ The response for the above aggregation:
The Geo Bounds Aggregation is also supported on `geo_shape` fields. The Geo Bounds Aggregation is also supported on `geo_shape` fields.
If <<geo-bounds-wrap-longitude,`wrap_longitude`>> is set to `true`
(the default), the bounding box can overlap the international date line and
return a bounds where the `top_left` longitude is larger than the `top_right`
longitude.
For example, the upper right longitude will typically be greater than the lower
left longitude of a geographic bounding box. However, when the area
crosses the 180° meridian, the value of the lower left longitude will be
greater than the value of the upper right longitude. See
http://docs.opengeospatial.org/is/12-063r5/12-063r5.html#30[Geographic bounding box] on the Open Geospatial Consortium website for more information.
Example: Example:
[source,console] [source,console]