Class: GeoBoundingBoxFilter

GeoBoundingBoxFilter

ElasticSearch geo bounding box filter.

Constructor

new GeoBoundingBoxFilter(termPath, west, south, east, north) → {Filter}

Parameters:
Name Type Description
termPath string

document path to term containing location.
west string | number

Longitude of WESTERN point.
south string | number

Latitude of SOUTHERN point.
east string | number

Longitude of EASTERN point.
north string | number

Latitude of NORTHERN point.
Source:
To Do:
  • implement base filter with cache control Note: lon before lat, to match GeoJson spec. If you have 2 points [Southwest, Northeast], pass lon1, lat1, lon2, lat2
Returns:

Filter object constructed. Serializes to geo filter.

Type
Filter

Extends

GeoBoundingBoxFilter

ElasticSearch geo bounding box filter.

Constructor

new GeoBoundingBoxFilter(termPath, west, south, east, north) → {Filter}

Parameters:
Name Type Description
termPath string

document path to term containing location.
west string | number

Longitude of WESTERN point.
south string | number

Latitude of SOUTHERN point.
east string | number

Longitude of EASTERN point.
north string | number

Latitude of NORTHERN point.
Source:
To Do:
  • implement base filter with cache control Note: lon before lat, to match GeoJson spec. If you have 2 points [Southwest, Northeast], pass lon1, lat1, lon2, lat2
Returns:

Filter object constructed. Serializes to geo filter.

Type
Filter

Extends