An array of reference identifier patterns that are supported by this reference provider. The patterns are returned as RegExp objects.
Adds a CoordinateReference to this reference provider.
From the moment a reference is added to this reference provider it can be retrieved from the getReference method and isValidReferenceIdentifier will return true for the reference's identifier.
There are two typical scenarios where this method can be used:
const reference = parseWellKnownText(wktString);
if (reference && reference.identifier) {
// Add new reference to the ReferenceProvider if not present
if (!isValidReferenceIdentifier(reference.identifier)) {
addReference(reference);
}
}
// Later, the reference can be obtained using the identifier
const ref = getReference(reference.identifier);
The reference to be added to this reference provider.
The identifier for the given reference. If no identifier is provided the
reference.identifier
property will be used as identifier. If reference.identifier
is not defined,
an exception will be thrown.
Creates a non-spatial CoordinateReference with a CARTESIAN CoordinateType. Such a reference is minimally defined by it axes, more specifically the UnitOfMeasure of the axes.
an object literal containing information required to create the CartesianReference
The reference. This reference is a non-spatial reference.
Creates a new topocentric reference based on the given options.
A topocentric coordinate system is a right-handed cartesian coordinate system with the following properties:
The topocentric reference uses the same geodetic datum as the origin point's coordinate reference.
the reference options.
the reference.
Retrieves the height above terrain spatial reference corresponding to the given identifier. The vertical reference of the returned reference is defined Above Terrain Surface. This has an effect on all the z-coordinates of your shapes, which will all be interpreted as a height offset from the terrain that is present in your map.
The terrain of your map itself is defined in an Above Mean Sea Level (AMSL) reference. As such, a height above terrain reference should be considered as an offset on top of this AMSL terrain data.
The isValidReferenceIdentifier function can be used to test if the reference corresponding to the given identifier is available in this reference provider. To add new references to this reference provider use addReference.
To retrieve an Above Mean Sea Level (AMSL) reference, use getReference.
Note that it is not possible to get a non-spatial height above terrain CoordinateReference
the reference identifier
The requested spatial reference with its vertical reference defined as an offset on top of the terrain data of the map.
Retrieves the spatial reference corresponding to the given identifier. The vertical reference of the returned reference is defined as Above Mean Sea Level (AMSL).
This has an effect on all the z-coordinates of your shapes, which will all be interpreted as AMSL.
You can use the isValidReferenceIdentifier function to test if the reference corresponding to the given identifier is available in this reference provider. To add new references to this reference provider, use addReference.
To retrieve a height above terrain reference, use getHeightAboveTerrainReference.
the reference identifier
The requested spatial reference, with its vertical reference defined Above Mean Sea Level (AMSL)
Determines if the reference corresponding to the given identifier is available in this reference provider.
To add new references to this reference provider, use addReference.
The references available by default are:
the reference identifier
true
if the reference corresponding to the given identifier is available; false otherwise
Parses a given WKT-string or a WKT resource identifier (uri) into a CoordinateReference
object.
A reference encoded as Well-Known Text (WKT).
The name of the authority that specified the reference. For example, EPSG. By default, this information is parsed from the authority tags in the WKT string.
The identifier of the reference. For example, 4326. By default, this information is parsed from the authority tags in the WKT string.
options for the WKT parsing or reference creation.
The reference corresponding to the WKT-string. If the authority name and code were not present in the WKT string or given when calling this method, the identifier of this reference is undefined
To be able to get this CoordinateReference
when you call
getReference, you need to add it to the
reference provider with addReference first.
A factory class for CoordinateReference instances. This factory allows you to: