MapImage
require(["esri/layers/support/MapImage"], function(MapImage) { /* code goes here */ });esri/layers/support/MapImageRepresents the data object for the dynamically generated map. This is generated after the promise returned from the export operation on Geoprocessor.getResultImage() resolves.
- See also:
Constructors
- new MapImage(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 | |
| Extent | The extent of the exported map. more details | more details | MapImage | |
| Number | The requested image height in pixels. more details | more details | MapImage | |
| String | URL to the returned image. more details | more details | MapImage | |
| Number | The opacity of the image. more details | more details | MapImage | |
| Number | Scale of the requested dynamic map. more details | more details | MapImage | |
| Boolean | Indicates if the requested image is visible in the view. more details | more details | MapImage | |
| Number | The requested image width in pixels. more details | more details | MapImage |
Property Details
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className.
- extentExtent
The extent of the exported map.
- heightNumber
The requested image height in pixels.
- hrefString
URL to the returned image. The image format must be of a type supported by the HTML
<img>tag.Possible Values: gif | jpg | png | bmp
- opacityNumber
The opacity of the image. Value can be any number between
0and1where0is 100% transparent,0.5is 50% transparent and1is fully opaque.- Default Value:1
- scaleNumber
Scale of the requested dynamic map.
- visibleBoolean
Indicates if the requested image is visible in the view.
- Default Value:true
- widthNumber
The requested image width in pixels.
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| * | 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 details | MapImage | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | MapImage |
Method Details
- 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
jsonparameter 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 ObjectA 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:Type Description * 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:Type Description Object The ArcGIS portal JSON representation of an instance of this class.