Hide Table of Contents
esri/dijit/util
esri/layer/pixelFilters
esri/process
esri/workers
Class: SpatialReference

require(["esri/SpatialReference"], function(SpatialReference) { /* code goes here */ });

Description

(Added at v1.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). Note that versions prior to ArcGIS 10 only wkid was supported. For a complete list of supported IDs and their corresponding definition strings:

See also

Samples

Search for samples that use this class.

Subclasses

Constructors

NameSummary
new SpatialReference(json)Creates a new SpatialReference object.
new SpatialReference(wkid)Create a spatial reference object and initialize it with a well-known ID (wkid).
new SpatialReference(wkt)Create a spatial reference object and initialize it with the given well-known text (wkt).

Properties

NameTypeSummary
wkidNumberThe well-known ID of a spatial reference.
wktStringThe well-known text that defines a spatial reference.

Methods

NameReturn typeSummary
equals(sr)BooleanReturns true if the input spatial reference object has the same wkid or wkt as this spatial reference object.
isWebMercator()BooleanReturns true if the wkid of the spatial reference object is one of the following values: 102113, 102100, 3857.
toJson()ObjectReturns an easily serializable object representation of the spatial reference.
Constructor Details

new SpatialReference(json)

Creates a new SpatialReference object.
Parameters:
<Object> json Required The REST JSON representation of the spatial reference. {"wkid" : <wkid>}
Sample:

Specify the spatial reference using either well-known text (wkt) or a well-known id (wkid). Note that pre 10 only wkid was supported.

require([
  "esri/SpatialReference", ... 
], function(SpatialReference, ... ) {
  var spatialReference = new SpatialReference({wkid:32662});

  var spatialReference2 = new SpatialReference({"wkt": 'PROJCS["NAD_1983_HARN_StatePlane_Oregon_North_FIPS_3601",' + 
    'GEOGCS["GCS_North_American_1983_HARN",DATUM["D_North_American_1983_HARN",' +
    'SPHEROID["GRS_1980",6378137.0,298.257222101]]' +
    'PRIMEM["Greenwich",0.0],' +
    'UNIT["Degree",0.0174532925199433]],PROJECTION["Lambert_Conformal_Conic"],' +
    'PARAMETER["False_Easting",8202099.737532808],PARAMETER["False_Northing",0.0],' +
    'PARAMETER["Central_Meridian",-120.5],' +
    'PARAMETER["Standard_Parallel_1",44.33333333333334],' +
    'PARAMETER["Standard_Parallel_2",46.0],' +
    'PARAMETER["Latitude_Of_Origin",43.66666666666666],UNIT["Foot",0.3048]]'
  });
  ...
});

new SpatialReference(wkid)

Create a spatial reference object and initialize it with a well-known ID (wkid). (Added at v2.8)
Parameters:
<Number> wkid Required The well-known id (wkid) of the coordinate system.
Sample:
require([
  "esri/SpatialReference", ... 
], function(SpatialReference, ... ) {
  var sr = new SpatialReference(4326);
  ...
});

new SpatialReference(wkt)

Create a spatial reference object and initialize it with the given well-known text (wkt). (Added at v2.8)
Parameters:
<String> wkt Required The well-known text (wkt) of the coordinate system.
Sample:
require([
  "esri/SpatialReference", ... 
], function(SpatialReference, ... ) {
  var sr = new SpatialReference('GEOGCS["GCS_WGS_1984",DATUM["D_WGS_1984",
    SPHEROID["WGS_1984",6378137.0,298.257223563]],
    PRIMEM["Greenwich",0.0],UNIT["Degree",0.0174532925199433]]'
  );
  ...
});
Property Details

<Number> wkid

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

<String> wkt

The well-known text that defines a spatial reference. Many browser 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 Details

equals(sr)

Returns true if the input spatial reference object has the same wkid or wkt as this spatial reference object. Returns false otherwise. (Added at v3.3)
Return type: Boolean
Parameters:
<SpatialReference> sr Required The spatial reference to compare. 
Sample:
require(["esri/SpatialReference"], function(SpatialReference) {
  var sr1 = new SpatialReference(4326);
  var sr2 = new SpatialReference(4326);
  console.log(sr1.equals(sr2)); // true
});

isWebMercator()

Returns true if the wkid of the spatial reference object is one of the following values: 102113, 102100, 3857. (Added at v3.3)
Return type: Boolean
Sample:
require([
  "esri/SpatialReference", ... 
], function(SpatialReference, ... ) {
  var sr = new SpatialReference(102100);
  console.log(sr.isWebMercator()); // true
  ...
});

toJson()

Returns an easily serializable object representation of the spatial reference.
Return type: Object