MapImage | References | ArcGIS Maps SDK for JavaScript

import MapImage from "@arcgis/core/layers/support/MapImage.js";

Inheritance:: MapImage→Accessor

Since: ArcGIS Maps SDK 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

JobInfo.fetchResultImage()

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`MapImageProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`extent`	`Extent \| null \| undefined`
`height`	`number \| null \| undefined`
`href`	`string \| null \| undefined`
`opacity`	`number`
`scale`	`number \| null \| undefined`
`visible`	`boolean`
`width`	`number \| null \| undefined`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

extent

autocast Property

Type: Extent | null | undefined

The extent of the exported map.

height

Property

Type: number | null | undefined

The requested image height in pixels.

href

Property

Type: string | null | undefined

URL to the returned image. The image format must be of a type supported by the HTML <img> tag.

opacity

Property

Type: 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

Property

Type: number | null | undefined

Scale of the requested dynamic map.

visible

Property

Type: boolean

Indicates if the requested image is visible in the view.

Default value: true

width

Property

Type: number | null | undefined

The requested image width in pixels.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.