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 {JobInfo.fetchResultImage() 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
String

The name of the class.

more details
Accessor
Extent

The extent of the exported map.

more details
MapImage
Number

The requested image height in pixels.

more details
MapImage
String

URL to the returned image.

more details
MapImage
Number

The opacity of the image.

more details
MapImage
Number

Scale of the requested dynamic map.

more details
MapImage
Boolean

Indicates if the requested image is visible in the view.

more details
MapImage
Number

The requested image width in pixels.

more details
MapImage

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

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
*

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

more details
MapImage
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

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

more details
MapImage

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

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.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
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.