MarkLogic 12 EA 1 Product Documentation
geo.geospatialQuery

geo.geospatialQuery(
   regions as cts.region[],
   [options as String[]],
   [weight as Number?]
) as cts.query

Summary

Returns a query matching points within given regions.

Parameters

regions One or more geographic boxes, circles, polygons, linestrings or points. Where multiple boxes, circles, polygons, lingstrings or points are specified, the query matches if any box, circle, polygon, linestring or point matches.

Parameters
regions	One or more geographic boxes, circles, polygons, linestrings or points. Where multiple boxes, circles, polygons, lingstrings or points are specified, the query matches if any box, circle, polygon, linestring or point matches.
options	Options to this query. The default is (). Options include: "coordinate-system=`string`" Use the given coordinate system. Valid values are: wgs84 The WGS84 coordinate system. wgs84/double The WGS84 coordinate system at double precision. etrs89 The ETRS89 coordinate system. etrs89/double The ETRS89 coordinate system at double precision. raw The raw (unmapped) coordinate system. raw/double The raw coordinate system at double precision. "units=value" Measure distance and the radii of circles in the specified units. Allowed values: `miles` (default), `km`, `feet`, `meters`. "precision=value" Use the coordinate system at the given precision. Allowed values: `float` and `double`. "type=value" Specify the format of point coordinates, either (lat,long) or (long,lat). Latitude-first order is the default. Allowed values: `point` (default) or `long-lat-point`. "boundaries-included" Points on boxes' and circles' boundaries are counted as matching. This is the default. "boundaries-excluded" Points on boxes' and circles' 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.
weight	A weight for this query. The default is 1.0.

options

Options to this query. The default is ().

Options include:

"coordinate-system=string"

Use the given coordinate system. Valid values are:

wgs84
The WGS84 coordinate system.

wgs84/double
The WGS84 coordinate system at double precision.

etrs89
The ETRS89 coordinate system.

etrs89/double
The ETRS89 coordinate system at double precision.

raw
The raw (unmapped) coordinate system.

raw/double
The raw coordinate system at double precision.

"units=value"

Measure distance and the radii of circles in the specified units. Allowed values: miles (default), km, feet, meters.

"precision=value"

Use the coordinate system at the given precision. Allowed values: float and double.

"type=value"

Specify the format of point coordinates, either (lat,long) or (long,lat). Latitude-first order is the default. Allowed values: point (default) or long-lat-point.

"boundaries-included"

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

"boundaries-excluded"

Points on boxes' and circles' 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.

weight A weight for this query. The default is 1.0.

Usage Notes

Point values and boundary specifications of boxes are given in degrees relative to the WGS84 coordinate system. Southern latitudes and Western longitudes take negative values. Longitudes will be wrapped to the range (-180,+180) and latitudes will be clipped to the range (-90,+90).

If the northern boundary of a box is south of the southern boundary, no points will match. However, longitudes wrap around the globe, so that if the western boundary is east of the eastern boundary, then the box crosses the anti-meridian.

Special handling occurs at the poles, as all longitudes exist at latitudes +90 and -90.

The query constructed will examine points in all the supported geospatial markup vocabularies. If not all these vocabularies will be in use, it may be more efficient to use the query constructors for just the vocabulary or vocabularies that are in actual use.

Example

// Assume you've previously inserted the following document into the database.
declareUpdate();
xdmp.documentInsert('example.json',
  { type: 'Feature',  
    geometry: {    
      type: 'Point',    
      coordinates: [125.6, 8.1]
     },
     properties: { name: 'Test' }
  });

// Then in a separate query, you can perform the following search
// to match this document.
const geo = require('/MarkLogic/geospatial/geospatial');
cts.search(
  geo.geospatialQuery(
    cts.box(1, 120, 35, 131), 
    ['coordinate-system=wgs84'], 
    2.0));

// Returns the contents of example.json

MarkLogic 12 EA 1 Product Documentationgeo.geospatialQuery

Summary

Usage Notes

See Also

Example

MarkLogic 12 EA 1 Product Documentation
geo.geospatialQuery