ProjectParameters

AMD: require(["esri/tasks/support/ProjectParameters"], (ProjectParameters) => { /* code goes here */ });
ESM: import ProjectParameters from "@arcgis/core/tasks/support/ProjectParameters";
Class: esri/tasks/support/ProjectParameters
Inheritance: ProjectParameters Accessor
Since: ArcGIS API for JavaScript 4.0
Deprecated since version 4.20. Use ProjectParameters instead.

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
Stringmore details

The name of the class.

more detailsAccessor
Geometry[]more details

The input geometries to project.

more detailsProjectParameters
SpatialReferencemore details

The spatial reference to which you are projecting the geometries.

more detailsProjectParameters
Objectmore details

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

more detailsProjectParameters
Booleanmore details

Indicates whether to transform forward or not.

more detailsProjectParameters

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API 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 API 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

Name Return Type Summary Class
Objectmore details

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

more detailsProjectParameters

Method Details

toJSON(){Object}static

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.