ProjectParameters

require(["esri/tasks/support/ProjectParameters"], function(ProjectParameters) { /* code goes here */ });
Class: esri/tasks/support/ProjectParameters
Inheritance: ProjectParameters Accessor
Since: ArcGIS API 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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
Geometry[]

The input geometries to project.

more details
more detailsProjectParameters
SpatialReference

The spatial reference to which you are projecting the geometries.

more details
more detailsProjectParameters
SpatialReference

The spatial reference to which you are projecting the geometries.

more details
more detailsProjectParameters
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
more detailsProjectParameters
Boolean

Indicates whether to transform forward or not.

more details
more detailsProjectParameters

Property Details

declaredClassStringreadonly inherited

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

geometriesGeometry[]

The input geometries to project.

outSpatialReferenceSpatialReference

Since: ArcGIS API for JavaScript 4.4

The spatial reference to which you are projecting the geometries.

Deprecated
  • since version 4.4.

The spatial reference to which you are projecting the geometries. Use outSpatialReference instead.

transformationObject

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.

transformForwardBoolean

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

Method Overview

NameReturn TypeSummaryClass
Object

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

more details
more detailsProjectParameters

Method Details

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:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.