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: MapImage
[ AMD Module Require | Legacy Module Require ]
require(["esri/layers/MapImage"], function(MapImage) { /* code goes here */ });
Description
(Added at v1.0)
Represents the data object for the dynamically generated map. This is returned after a successful export operation on ArcGISDynamicMapServiceLayer and Geoprocessor.getResultImage in the callback and in the event result. The MapImage class can also be used to create a geo-referenced image file for use with the MapImageLayer.Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new MapImage(options) | Creates a new Map Image object. |
Properties
| Name | Type | Summary |
|---|---|---|
| extent | Extent | Extent of exported map. |
| height | Number | Requested image height in pixels. |
| href | String | URL to returned image. |
| scale | Number | Scale of requested dynamic map. |
| width | Number | Requested image width in pixels. |
Constructor Details
Creates a new Map Image object.
Parameters:
< |
Required | An object that defines the map image options. |
options properties: < |
Optional | Specfiy an extent for the image. |
< |
Optional | Specify the url of the image. |
Sample:
require([
"esri/layers/MapImage", ...
], function(MapImage, ... ) {
var mi = new MapImage({
'extent': { 'xmin': -8864908, 'ymin': 3885443, 'xmax': -8762763, 'ymax': 3976997, 'spatialReference': { 'wkid': 3857 }},
'href': imageURL
});
...
});
Property Details
<Extent
ExtentExtent of exported map.
<Number
NumberRequested image height in pixels.
<String
StringURL to returned image. The image format must be of a type supported by the HTML img tag.
Known values:
gif | jpg | png | bmp<Number
NumberScale of requested dynamic map.
<Number
NumberRequested image width in pixels.