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

Represents 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 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
Extent

The extent of the exported map.

more details
more detailsMapImage
Number

The requested image height in pixels.

more details
more detailsMapImage
String

URL to the returned image.

more details
more detailsMapImage
Number

The opacity of the image.

more details
more detailsMapImage
Number

Scale of the requested dynamic map.

more details
more detailsMapImage
Boolean

Indicates if the requested image is visible in the view.

more details
more detailsMapImage
Number

The requested image width in pixels.

more details
more detailsMapImage

Property Details

declaredClassStringreadonly inherited

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.

Known Values: gif | jpg | png | bmp

opacityNumber

The opacity of the image. Value can be any number between 0 and 1 where 0 is 100% transparent, 0.5 is 50% transparent and 1 is 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

NameReturn TypeSummaryClass
*

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 detailsMapImage
Object

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

more details
more detailsMapImage

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 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.