SpatialReference

require(["esri/geometry/SpatialReference"], function(SpatialReference) { /* code goes here */ });
Class: esri/geometry/SpatialReference
Inheritance: SpatialReference Accessor
Since: ArcGIS API for JavaScript 4.0

The spatial reference of a map, layer, or inputs to and outputs from a task. Each projected and geographic coordinate system is defined by either a well-known ID (WKID) or a definition string (WKT). Versions prior to ArcGIS 10 only supported WKID. For a full list of supported spatial reference IDs and their corresponding definition strings, see the links below.

See also:

Constructors

new SpatialReference(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
Boolean

Indicates if the spatial reference refers to a geographic coordinate system.

more details
more detailsSpatialReference
Boolean

Indicates if the wkid of the spatial reference object is one of the following values: 102113, 102100, 3857.

more details
more detailsSpatialReference
Boolean

Indicates if the wkid of the spatial reference object is 4326.

more details
more detailsSpatialReference
Boolean

Indicates if the spatial reference of the map supports wrapping around the International Date Line.

more details
more detailsSpatialReference
SpatialReference

A convenience spatial reference instance for Web Mercator.

more details
more detailsSpatialReference
SpatialReference

A convenience spatial reference instance for WGS84.

more details
more detailsSpatialReference
Number

The well-known ID of a spatial reference.

more details
more detailsSpatialReference
String

The well-known text that defines a spatial reference.

more details
more detailsSpatialReference

Property Details

declaredClassStringreadonly inherited

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

isGeographicBooleanreadonly

Indicates if the spatial reference refers to a geographic coordinate system.

isWebMercatorBooleanreadonly

Indicates if the wkid of the spatial reference object is one of the following values: 102113, 102100, 3857.

isWGS84Booleanreadonly

Indicates if the wkid of the spatial reference object is 4326.

isWrappableBooleanreadonly

Indicates if the spatial reference of the map supports wrapping around the International Date Line. Value is true if the spatial reference is Web Mercator or WGS84.

WebMercatorSpatialReference

A convenience spatial reference instance for Web Mercator. This property is static.

Example:
// returns true if the webMercatorUtils can
// project geometries from WGS84 to Web Mercator
var canProjectWGS84toWebMercator = webMercatorUtils.canProject(SpatialReference.WGS84, SpatialReference.WebMercator);

A convenience spatial reference instance for WGS84. This property is static.

Example:
// returns true if the webMercatorUtils can
// project geometries from WGS84 to Web Mercator
var canProjectWGS84toWebMercator = webMercatorUtils.canProject(SpatialReference.WGS84, SpatialReference.WebMercator);

wkidNumber

The well-known ID of a spatial reference. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references.

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.

Method Overview

NameReturn TypeSummaryClass
SpatialReference

Returns a deep clone of the spatial reference object.

more details
more detailsSpatialReference
Boolean

Checks if the specified spatial reference object has the same wkid or wkt as this spatial reference object.

more details
more detailsSpatialReference
*

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform.

more details
more detailsSpatialReference
Object

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

more details
more detailsSpatialReference

Method Details

Returns a deep clone of the spatial reference object.

Returns:
TypeDescription
SpatialReferenceReturns a deep clone of the spatial reference object.

equals(spatialReference){Boolean}

Checks if the specified spatial reference object has the same wkid or wkt as this spatial reference object.

Parameter:
spatialReference SpatialReference

The spatial reference to compare to.

Returns:
TypeDescription
BooleanReturns true if the input spatial reference object has the same wkid or wkt as this spatial reference object.
Example:
require(["esri/geometry/SpatialReference"], function(SpatialReference) {
  var sr1 = new SpatialReference(4326);
  var sr2 = new SpatialReference(4326);
  console.log(sr1.equals(sr2)); // true
});

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
TypeDescription
*Returns a new instance of this class.

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.