ejsGeoBoundsAggregation

A metric aggregation that computes the bounding box containing all geo_point values for a field.

Module

 GeoBoundsAggregation

GeoBoundsAggregation ( name )

Aggregation that computes the bounding box containing all geo_point values for a field.


Parameters
name <String> The name which be used to refer to this aggregation.

Method Summary

Returns Name Description
String_type()The type of ejs object. For internal use only.
Objectfield(field)

Sets the field to operate on.

StringtoJSON()

Retrieves the internal agg object. This is typically used by internal API functions so use with caution.

ObjectwrapLongitude(trueFalse)Optional parameter which specifies whether the bounding box should be allowed to overlap the international date line. The default value is true

Method Detail

 _type

String _type ( )
The type of ejs object. For internal use only.

Returns
the type of object

 field

Object field ( field )

Sets the field to operate on.


Parameters
field <String> a valid field name..
Returns
returns this so that calls can be chained.

 toJSON

String toJSON ( )

Retrieves the internal agg object. This is typically used by internal API functions so use with caution.


Returns
returns this object's internal object.

 wrapLongitude

Object wrapLongitude ( trueFalse )
Optional parameter which specifies whether the bounding box should be allowed to overlap the international date line. The default value is true

Parameters
trueFalse <Boolean> to overlap the international date line.
Returns
returns this so that calls can be chained.

Request

Queries

Filters

Aggregations

Facets

Suggesters

Geo