MarkLogic 10 Product Documentation
geo.interiorPoint

geo.interiorPoint(
   region as cts.region,
   [options as String[]]
) as cts.point?

Summary

This function returns a point that is guaranteed to be inside the bounds of the given region. For a given region and set of options, the point returned should be stable from one call to the next.

Parameters

region A cts region.

Parameters
region	A cts region.
options	Options include: "coordinate-system=value" Use the given coordinate system. Valid values are `wgs84`, `wgs84/double`, `etrs89`, `etrs89/double`, `raw` and `raw/double`. Defaults to the governing coordinating system. "precision=value" Use the coordinate system at the given precision. Allowed values: `float` and `double`. Defaults to the precision of the governing coordinate system. "units=value" Measure distance, radii of circles, and tolerance in the specified units. Allowed values: `miles` (default), `km`, `feet`, `meters`. "tolerance=distance" Tolerance is the largest allowable variation in geometry calculations. If the distance between two points is less than tolerance, then the two points are considered equal. For the raw coordinate system, use the units of the coordinates. For geographic coordinate systems, use the units specified by the units option.

options

Options include:

"coordinate-system=value"

Use the given coordinate system. Valid values are wgs84, wgs84/double, etrs89, etrs89/double, raw and raw/double. Defaults to the governing coordinating system.

"precision=value"

Use the coordinate system at the given precision. Allowed values: float and double. Defaults to the precision of the governing coordinate system.

"units=value"

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

"tolerance=distance"

Tolerance is the largest allowable variation in geometry calculations. If the distance between two points is less than tolerance, then the two points are considered equal. For the raw coordinate system, use the units of the coordinates. For geographic coordinate systems, use the units specified by the units option.

Usage Notes

Under extreme circumstances a point may be returned that may in fact not be inside a polygon, due to the limits of floating point arithmetic. Double precision should be used to get more accurate results.

The value of the precision option takes precedence over that implied by the governing coordinate system name, including the value of the coordinate-system option. For example, if the governing coordinate system is "wgs84/double" and the precision option is "float", then the operation uses single precision.

Example

geo.interiorPoint(cts.polygon('10,10 20,20 50,50 10,10'))

// => a cts.point with the coordinates 30,25

MarkLogic 10 Product Documentationgeo.interiorPoint

Summary

Usage Notes

See Also

Example

MarkLogic 10 Product Documentation
geo.interiorPoint