ProjectParameters
require(["esri/tasks/support/ProjectParameters"], function(ProjectParameters) { /* code goes here */ });esri/tasks/support/ProjectParametersDefines the projection parameters used when calling the GeometryService.project().
Constructors
- new ProjectParameters(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | The name of the class. more details | more details | Accessor | |
| Geometry[] | The input geometries to project. more details | more details | ProjectParameters | |
| SpatialReference | The spatial reference to which you are projecting the geometries. more details | more details | ProjectParameters | |
| SpatialReference | The spatial reference to which you are projecting the geometries. more details | 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 | more details | ProjectParameters | |
| Boolean | Indicates whether to transform forward or not. more details | more details | ProjectParameters |
Property Details
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className.
- geometriesGeometry[]
The input geometries to project.
- outSpatialReferenceSpatialReferenceSince: ArcGIS API for JavaScript 4.4
The spatial reference to which you are projecting the geometries.
- DeprecatedoutSRSpatialReference
- 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:
- optionalwkid Number
The well-known ID of the datum transformation to apply to the projection. List of valid IDs for Datum transformations.
optionalwkt StringThe 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
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | ProjectParameters |
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:Type Description Object The ArcGIS portal JSON representation of an instance of this class.