geo.shortestDistance

geo.shortestdistancegeoshortestdistance

/apidoc/8.0/geo:shortest-distance.xml

Returns the great circle distance (in miles) between a point and an region. The region is defined by a cts:region.

The first point.

p1

cts.point

A region such as a circle, box, polygon, linestring, or complex-polygon. For compatibility with previous versions, a sequence of points is interpreted as a sequence of arcs (defined pairwise) and the distance returned is the shortest distance to one of those points. If the first parameter is a point within the region specified in this parameter, then cts:shortest-distance returns 0. If the point specified in the first parameter in not in the region specified in this parameter, then cts:shortest-distance returns the shortest distance to the boundary of the region.

region

cts.region[]

Options for the operation. The default is ().

Options include:

"coordinate-system=wgs84"

Use the WGS84 coordinate system.

"units=miles"

Distance is measured in miles.

options

String[]

Number

geo.shortestDistance(
  cts.point(37.494965, -122.267654),
  cts.linestring([cts.point(40.720921, -74.008878),
                  cts.point(38.950224, -77.019714)]);
)
=> 2431.82739813132, which is the shortest distance (in miles)
   between San Carlos, CA and an arc between New York City and
   Washington DC.