MarkLogic 10 Product Documentation
cts.geospatialElementReference

cts.geospatialElementReference(
   element as xs.QName,
   [options as String[]]
) as cts.reference

Summary

Creates a reference to a geospatial element range index, for use as a parameter to cts.valueTuples. This function will throw an exception if the specified range index does not exist.

Parameters

element An element name.

Parameters
element	An element name.
options	Options. The default is (). Options include: "type=type" Use the lexicon with the type specified by type (point or long-lat-point) "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. "precision=value" Use the coordinate system at the given precision. Allowed values: `float` and `double`. "nullable" Allow null values in tuples reported from `cts.valueTuples` when using this lexicon. "unchecked" Read the scalar type and coordinate-system info only from the input. Do not check the definition against the context database.

options

Options. The default is ().

Options include:

"type=type"

Use the lexicon with the type specified by type (point or long-lat-point)

"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.

"precision=value"

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

"nullable"

Allow null values in tuples reported from cts.valueTuples when using this lexicon.

"unchecked"

Read the scalar type and coordinate-system info only from the input. Do not check the definition against the context database.

Usage Notes

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 reference uses single precision. An exception is thrown if no index with the specified precision exists.

Example

cts.geospatialElementReference(xs.QName("point"));

=> cts.geospatialElementReference(fn.QName("","point"),
     ["type=point","coordinate-system=wgs84"])

MarkLogic 10 Product Documentationcts.geospatialElementReference

Summary

Usage Notes

See Also

Example

MarkLogic 10 Product Documentation
cts.geospatialElementReference