ProjectParameters

AMD: require(["esri/rest/support/ProjectParameters"], (ProjectParameters) => { /* code goes here */ });
ESM: import ProjectParameters from "@arcgis/core/rest/support/ProjectParameters";
Class: esri/rest/support/ProjectParameters
Inheritance: ProjectParameters Accessor
Since: ArcGIS Maps SDK for JavaScript 4.0

Defines the projection parameters used when calling the geometryService.project().

See also

Constructors

new ProjectParameters(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 Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
Accessor
Geometry[]

The input geometries to project.

more details
ProjectParameters
SpatialReference

The spatial reference to which you are projecting the geometries.

more details
ProjectParameters
Object

The well-known id {wkid:number} or well-known text {wkt:string} of the datum transformation to be applied to the projected geometries.

more details
ProjectParameters
Boolean

Indicates whether to transform forward or not.

more details
ProjectParameters

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS Maps SDK for JavaScript 4.7

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

geometries Geometry[]

The input geometries to project.

outSpatialReference SpatialReference
Since: ArcGIS Maps SDK for JavaScript 4.4

The spatial reference to which you are projecting the geometries.

transformation Object

The well-known id {wkid:number} or well-known text {wkt:string} of the datum transformation to be applied to the projected geometries. See Datum transformations for a list of valid datum transformations that may be used here.

If a transformation is specified, a value must also be specified in the transformForward property.

Properties
wkid Number
optional

The well-known ID of the datum transformation to apply to the projection. List of valid IDs for Datum transformations.

wkt String
optional

The well-known text that defines a spatial reference. Many browsers have a limit to the length of a GET request of approximately 2048 characters. When using well-known text to specify the spatial reference you can easily exceed this limit. In these cases, you will need to setup and use a proxy page.

transformForward Boolean

Indicates whether to transform forward or not. The forward or reverse direction of transformation is implied in the name of the transformation.

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.

more details
Accessor
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
ProjectParameters

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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.

hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

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(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

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");
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

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