Loading TOC...

geo.boundingBoxes

geo.boundingBoxes(
   $region as cts.region,
   [$options as String[]]
) as ValueIterator

Summary

Returns a sequence of boxes that bound the given region.

Parameters
$region A geographic region (box, circle, polygon, or point).
$options Options for the operation. The default is ().

Options include:

Options include:

"coordinate-system=string"
Use the given coordinate system. Valid values are:
wgs84
The WGS84 coordinate system.
raw
The raw (unmapped) coordinate system.
"units=miles"
Distance (for circles) is measured in miles.
"box-percent=n"
An integer between 0 and 100 (default is 100) that indicates what percentage of a polygon's bounding box slivers should be returned. Lower numbers give fewer, less accurate boxes; larger numbers give more, more accurate boxes.
"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.

Example

geo.boundingBoxes(
  cts.polygon("0,0 20,20 -10,18 5,5 0,0")
);
// Returns two boxes:
//   [-10, 0, 5, 18.976505]
//   [5, 4.7157488, 20, 20]

// **************
geo.boundingBoxes(
  cts.polygon("0,0 20,20 -10,18 5,5 0,0"),
  "box-percent=50"
);
// Returns one box:
//   [-10, 0, 20, 20]

Comments

    Powered by MarkLogic Server 7.0-4.1 and rundmc | Terms of Use | Privacy Policy