GeographicTransformationStep

AMD: require(["esri/geometry/operators/support/GeographicTransformationStep"], (GeographicTransformationStep) => { /* code goes here */ });
ESM: import GeographicTransformationStep from "@arcgis/core/geometry/operators/support/GeographicTransformationStep.js";
Class: esri/geometry/operators/support/GeographicTransformationStep
Inheritance: GeographicTransformationStepAccessor
Since: ArcGIS Maps SDK for JavaScript 4.32

Represents a step in the process of transforming coordinates from one geographic coordinate system to another. A geographic transformation step can be constructed from a well-known ID (wkid) or a well known text (wkt) that represents a geographic datum transformation.

See also

Constructors

GeographicTransformationStep

Constructor
new GeographicTransformationStep(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Watch for changes topic.
Show inherited properties Hide inherited properties
Name Type Summary Class

The name of the class.

Accessor

Indicates if the geographic transformation is inverted.

GeographicTransformationStep

The well-known id (wkid) hat represents a known geographic transformation.

GeographicTransformationStep

The well-known text (wkt) that represents a known geographic transformation.

GeographicTransformationStep

Property Details

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

isInverse

Property
isInverse Boolean

Indicates if the geographic transformation is inverted.

Default Value:false

wkid

Property
wkid Number |null |undefined

The well-known id (wkid) hat represents a known geographic transformation. See Geographic datum transformations for the list of supported equation-based geographic transformations.

Example
// Create a geographic transformation step for Tokyo_To_WGS_1984_2001 using its wkid
let geoStep = new GeographicTransformationStep({ wkid: 108106 });

wkt

Property
wkt String |null |undefined

The well-known text (wkt) that represents a known geographic transformation. See Geographic datum transformations for the list of supported equation-based geographic transformations.

Example
// Create a geographic transformation step for NAD_1927_To_WGS_1984_1
// using its well known text or wkt
let wkt = "GEOGTRAN[\"NAD_1927_To_WGS_1984_1\",GEOGCS[\"GCS_North_American_1927\",DATUM[\"D_North_American_1927\",SPHEROID[\"Clarke_1866\",6378206.4,294.9786982]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],GEOGCS[\"GCS_WGS_1984\",DATUM[\"D_WGS_1984\",SPHEROID[\"WGS_1984\",6378137.0,298.257223563]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],METHOD[\"Geocentric_Translation\"],PARAMETER[\"X_Axis_Translation\",-3.0],PARAMETER[\"Y_Axis_Translation\",142.0],PARAMETER[\"Z_Axis_Translation\",183.0]]";

let geoStep = new GeographicTransformationStep({ wkt });

Method Overview

Show inherited methods Hide inherited methods
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 step.

GeographicTransformationStep

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
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();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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

Method
getInverse(){GeographicTransformationStep}

Returns the inverse of this geographic transformation step. 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_1 transformation, then the inverse will transform from NAD 83 (NSRS 2007) to NAD 83 (HARN).

Returns
Type Description
GeographicTransformationStep Returns the inverse of the geographic transformation step.
Example
// Get the inverse of the geographic transformation step for Tokyo_To_WGS_1984_2001 using its wkid
let geoStep = new GeographicTransformationStep({ wkid: 108106 });

let inverse = geoStep.getInverse();

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if 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");
}

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close