MapImage

AMD: require(["esri/layers/support/MapImage"], (MapImage) => { /* code goes here */ });
ESM: import MapImage from "@arcgis/core/layers/support/MapImage";
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.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Extentmore details

The extent of the exported map.

more detailsMapImage
Numbermore details

The requested image height in pixels.

more detailsMapImage
Stringmore details

URL to the returned image.

more detailsMapImage
Numbermore details

The opacity of the image.

more detailsMapImage
Numbermore details

Scale of the requested dynamic map.

more detailsMapImage
Booleanmore details

Indicates if the requested image is visible in the view.

more detailsMapImage
Numbermore details

The requested image width in pixels.

more detailsMapImage

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

extent Extent

The extent of the exported map.

height Number

The requested image height in pixels.

href String

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"

opacity Number

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
scale Number

Scale of the requested dynamic map.

visible Boolean

Indicates if the requested image is visible in the view.

Default Value:true
width Number

The requested image width in pixels.

Method Overview

Name Return Type Summary Class
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsMapImage
Objectmore details

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

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 an ArcGIS product. 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:
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() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.