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
The geo_distance facet is a facet providing information for ranges of distances from a provided geo_point including count of the number of hits that fall within each range, and aggregation information (like total). Assuming the following sample doc:
When a to or from are not set, they are assumed to be unbounded. Ranges are allowed to overlap, basically, each range is treated by itself.
Options
unit: The unit the ranges are provided in. Defaults to km. Can also be mi or miles.
distance_type: How to compute the distance. Can either be arc (better precision) or plane (faster). Defaults to arc.
Value Options
On top of the count of hits falling within each range, aggregated data can be provided (total) as well. By default, the aggregated data will simply use the distance calculated, but the value can be extracted either using a different numeric field, or a script. Here is an example of using a different numeric field:
Note the params option, allowing to pass parameters to the script (resulting in faster script execution instead of providing the values within the script each time).
geo_point Type
The facet does not require the geo_point type to be set. It assumes that the location object indexed includes a lat and lon numeric values. The geo_point type follows these rules and allows for more flexible indexing options / structure, but is not required.
Multi Location Per Document
The facet can work with multiple locations per document.
The text was updated successfully, but these errors were encountered:
The
geo_distance
facet is a facet providing information for ranges of distances from a providedgeo_point
including count of the number of hits that fall within each range, and aggregation information (like total). Assuming the following sample doc:Here is an example that create a
geo_distance
facet from apin.location
of40,-70
, and a set of ranges.Accepted Formats
In much the same way the geo_point type can accept different representation of the geo point, the filter can accept it as well:
Lat Lon As Properties
Lat Lon As Array
Lat Lon As String
Geohash
Ranges
When a
to
orfrom
are not set, they are assumed to be unbounded. Ranges are allowed to overlap, basically, each range is treated by itself.Options
unit
: The unit the ranges are provided in. Defaults tokm
. Can also bemi
ormiles
.distance_type
: How to compute the distance. Can either bearc
(better precision) orplane
(faster). Defaults toarc
.Value Options
On top of the count of hits falling within each range, aggregated data can be provided (total) as well. By default, the aggregated data will simply use the distance calculated, but the value can be extracted either using a different numeric field, or a script. Here is an example of using a different numeric field:
And here is an example of using a script:
Note the params option, allowing to pass parameters to the script (resulting in faster script execution instead of providing the values within the script each time).
geo_point
TypeThe facet does not require the
geo_point
type to be set. It assumes that the location object indexed includes a lat and lon numeric values. Thegeo_poin
t type follows these rules and allows for more flexible indexing options / structure, but is not required.Multi Location Per Document
The facet can work with multiple locations per document.
The text was updated successfully, but these errors were encountered: