Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: ImageSpatialReference
[ AMD Module Require | Legacy Module Require ]
require(["esri/ImageSpatialReference"], function(ImageSpatialReference) { /* code goes here */ });
Description
(Added at v3.14)
Defines the Image Coordinate System (ICS) for ImageServices. An ICS defines the spatial reference in terms of a primary image. A primary image displayed in its own image coordinate system exhibits no distortions; other images and features can be projected to overlap with the primary image using its image coordinate system.
Many imagery-centric workflows require displaying images in image coordinate systems instead of map coordinates (geographic or projected coordinate systems); for example, oblique images are distorted significantly when displayed in map coordinates but can be displayed nicely in a top-up view without distortions.
Samples
Search for samples that use this class.Class hierarchy
esri/SpatialReference |_esri/ImageSpatialReference
Constructors
| Name | Summary |
|---|---|
| new ImageSpatialReference(params) | Creates an instance of ImageSpatialReference. |
Properties
| Name | Type | Summary |
|---|---|---|
| ics | Object | The full Image Coordinate System, which includes transformations and map spatial reference information specific to each image. |
| icsid | Number | The OBJECTID of the image in a mosaic dataset. |
| wkid | Number | The well-known ID of a spatial reference. |
| wkt | String | The well-known text that defines a spatial reference. |
Methods
| Name | Return type | Summary |
|---|---|---|
| equals(inSR, sr) | Boolean | Tests whether the input image coordinate system equals the image coordinate system of the instance calling this method. |
| isWebMercator() | Boolean | Returns true if the wkid of the spatial reference object is one of the following values: 102113, 102100, 3857. |
| toJson(preserveUrl?) | Boolean | Converts the ImageSpatialReference instance to a JSON object. |
Constructor Details
Creates an instance of ImageSpatialReference.
Parameters:
< |
Required | Options that may be passed into the constructor. See the object specification table below. |
params properties: < |
Optional | The full Image Coordinate System object, which includes transformations and map spatial reference information specific to each image. If this option isn't specified, then icsid must be specified. |
< |
Optional | The OBJECTID of the image in a mosaic dataset. If this option isn't specified, then ics must be specified. |
< |
Required | The url of the image service. |
Property Details
<Object
ObjectThe full Image Coordinate System, which includes transformations and map spatial reference information specific to each image.
<Number
NumberThe OBJECTID of the image in a mosaic dataset.
<Number
NumberThe well-known ID of a spatial reference. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references.
<String
StringThe well-known text that defines a spatial reference.
Method Details
Tests whether the input image coordinate system equals the image coordinate system of the instance calling this method.
Return type:
BooleanParameters:
< |
Required | The ImageSpatialReference to test the equality against this instance. |
< |
Required | The spatial reference to compare. |
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:
BooleanSample:
require([
"esri/SpatialReference", ...
], function(SpatialReference, ... ) {
var sr = new SpatialReference(102100);
console.log(sr.isWebMercator()); // true
...
});