Skip To Content ArcGIS for Developers Sign In Dashboard

TransformationCatalog QML Type

A type for discovering and managing transformations. More...

Import Statement: import Esri.ArcGISRuntime 100.6
Since: Esri.ArcGISRuntime 100.2
Inherits:

Object

Properties

Signals

Methods

  • DatumTransformation transformation(SpatialReference inputSpatialReference, SpatialReference outputSpatialReference, Envelope areaOfInterest)
  • DatumTransformation transformation(SpatialReference inputSpatialReference, SpatialReference outputSpatialReference)
  • list<DatumTransformation> transformationsBySuitability(SpatialReference inputSpatialReference, SpatialReference outputSpatialReference)
  • list<DatumTransformation> transformationsBySuitabilityWithAreaOfInterest(SpatialReference inputSpatialReference, SpatialReference outputSpatialReference, Envelope areaOfInterest)

Detailed Description

TransformationCatalog provides a mechanism for discovering available transformations. You can retrieve the default transformation or the best available transformation. Optionally, the area of interest may be considered in these calculations.

TransformationCatalog also allows you to set the location where Projection Engine data files are found on local storage. The projectionEngineDirectory property must be set before using any geometry classes.

Default transformations

The default transformation used is the most suitable one across the area covered by the input and output spatial references. You can sometimes get a more suitable transformation by specifying the extent your specific work area.

Property Documentation

projectionEngineDirectory : string

The location where Projection Engine data files are found on the local file system.


Signal Documentation

projectionEngineDirectoryChanged()

Emitted when the projectionEngineDirectory property changes.


Method Documentation

DatumTransformation transformation(SpatialReference inputSpatialReference, SpatialReference outputSpatialReference, Envelope areaOfInterest)

Returns the default transformation using an area of interest.

The default transformation is the one used in cases such as when calling GeometryEngine.project without specifying a transformation.

  • inputSpatialReference - The SpatialReference that transformation is from.
  • outputSpatialReference - The SpatialReference that transformation is to.
  • areaOfInterest - A geographic extent expressed as an Envelope.

If areaOfInterest has a different spatial reference than inputSpatialReference, it will be reprojected to inputSpatialReference. If areaOfInterest doesn't intersect the area of use of inputSpatialReference, this method returns null.

Returns null if no transform is needed to project from inputSpatialReference to outputSpatialReference.


DatumTransformation transformation(SpatialReference inputSpatialReference, SpatialReference outputSpatialReference)

Returns the default transformation without specifying an area of interest.

The default transformation is the one used in cases such as when calling GeometryEngine.project without specifying a transformation.

Returns null if no transform is needed to project from inputSpatialReference to outputSpatialReference.


list<DatumTransformation> transformationsBySuitability(SpatialReference inputSpatialReference, SpatialReference outputSpatialReference)

Returns the list of suitable datum transformations without specifying an area of interest.

Returns a list representing the datum transformations suitable for projecting between spatial references. The list is ordered in descending order by suitability, with the most suitable being first in the list. The list includes grid-based transformations, regardless of the presence or absence of required Projection Engine files supporting those transformations.


list<DatumTransformation> transformationsBySuitabilityWithAreaOfInterest(SpatialReference inputSpatialReference, SpatialReference outputSpatialReference, Envelope areaOfInterest)

Returns the list of suitable datum transformations using an area of interest.

Returns a list representing the datum transformations suitable for projecting between spatial references, and takes into account the area of interest. The list is ordered in descending order by suitability, with the most suitable being first in the list. The list includes grid-based transformations, regardless of the presence or absence of required Projection Engine files supporting those transformations.

  • inputSpatialReference - The SpatialReference that transformation is from.
  • outputSpatialReference - The SpatialReference that transformation is to.
  • areaOfInterest - A geographic extent expressed as an Envelope.

If areaOfInterest has a different spatial reference than inputSpatialReference, it will be reprojected to inputSpatialReference. If areaOfInterest doesn't intersect the area of use of inputSpatialReference, this method returns an empty list.



Feedback on this topic?