geo.boxIntersects

geo.boxintersectsgeoboxintersects

/apidoc/8.0/geo:box-intersects.xml

Returns true if the box intersects with a region.

A geographic box.

box

cts.box

One or more geographic regions (boxes, circles, polygons, or points). Where multiple regions are specified, return true if any region intersects the box.

region

cts.region[]

Options for the operation. The default is ().

Options include:

"coordinate-system=wgs84"

Use the WGS84 coordinate system.

"units=miles"

Distance (for circles) is measured in miles.

"boundaries-included"

Points on boxes', circles', and polygons' boundaries are counted as matching. This is the default.

"boundaries-excluded"

Points on boxes', circles', and polygons' boundaries are not counted as matching.

"boundaries-latitude-excluded"

Points on boxes' latitude boundaries are not counted as matching.

"boundaries-longitude-excluded"

Points on boxes' longitude boundaries are not counted as matching.

"boundaries-south-excluded"

Points on the boxes' southern boundaries are not counted as matching.

"boundaries-west-excluded"

Points on the boxes' western boundaries are not counted as matching.

"boundaries-north-excluded"

Points on the boxes' northern boundaries are not counted as matching.

"boundaries-east-excluded"

Points on the boxes' eastern boundaries are not counted as matching.

"boundaries-circle-excluded"

Points on circles' boundary are not counted as matching.

"boundaries-endpoints-excluded"

Points on linestrings' boundary (the endpoints) are not counted as matching.

options

String[]

Boolean

// Does the lat-long box between Greenwich and Edinburgh intersect with
// a 10 mile circle around Birmingham? Yes. 
geo.boxIntersects(
  cts.box(51.48, -3.188889, 55.953056, 0.0),
  cts.circle(10, cts.point(52.483056, -1.893611))); 
=> true