require(["esri/geometry/operators/support/GeographicTransformation"], (GeographicTransformation) => { /* code goes here */ });
import GeographicTransformation from "@arcgis/core/geometry/operators/support/GeographicTransformation.js";
esri/geometry/operators/support/GeographicTransformation
Create a geographic transformation that can be used to project 2D geometries between different geographic coordinate systems to ensure that data is properly aligned within a map. These transformations are used to transform coordinates between spatial references that have different geographic coordinate systems, and thus different datums.
A geographic transformation converts everything that needs to be changed including the units, prime meridian, and the ellipsoid. The transformation is defined by a series of steps, each of which is defined by a well-known text (WKT) string or a well-known ID (WKID). Using the most suitable transformation ensures the best possible accuracy when converting geometries from one spatial reference to another.
The geographicTransformationUtils module provides the getTransformation() and
getTransformations() methods which return the default geographic transformation
for the given projection or a list of suitable geographic transformations.
Known Limitations
Currently, the client-side projectOperator only supports equation-based geographic transformations.
- See also
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
The name of the class. | Accessor | ||
An ordered list of geographic transformation steps that represent the process of transforming coordinates from one geographic coordinate system to another. | GeographicTransformation |
Property Details
-
steps
Propertysteps GeographicTransformationStep[]autocast -
An ordered list of geographic transformation steps that represent the process of transforming coordinates from one geographic coordinate system to another. The steps are applied in the order in which they are defined.
To define the steps use the GeographicTransformationStep module.
- Default Value:[]
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Returns the inverse of this geographic transformation. | GeographicTransformation | ||
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor |
Method Details
-
Inherited from Accessor
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
getInverse
MethodgetInverse(){GeographicTransformation} -
Returns the inverse of this geographic transformation. The inverse of a transformation converts coordinates using the same method and parameters, but in the opposite direction of the original object. For example if the original object represents the
NAD_1983_HARN_To_NAD_1983_NSRS2007_1transformation, then the inverse will transform fromNAD 83 (NSRS 2007)toNAD 83 (HARN).ReturnsType Description GeographicTransformation
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");