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 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 | more details The name of the class. | more details | Accessor | |
| Extent | more details The extent of the exported map. | more details | MapImage | |
| Number | more details The requested image height in pixels. | more details | MapImage | |
| String | more details URL to the returned image. | more details | MapImage | |
| Number | more details The opacity of the image. | more details | MapImage | |
| Number | more details Scale of the requested dynamic map. | more details | MapImage | |
| Boolean | more details Indicates if the requested image is visible in the view. | more details | MapImage | |
| Number | more details The requested image width in pixels. | 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.
-
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
0and1where0is 100% transparent,0.5is 50% transparent and1is 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 details | MapImage | |
| more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor | ||
| Object | more details Converts an instance of this class to its ArcGIS portal JSON representation. | 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 an ArcGIS product. 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.
-
own(handleOrHandles)inheritedSince: ArcGIS API for JavaScript 4.24
-
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.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }); handle.remove(); // Assign a handle using own() this.own(reactiveUtils.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }));Parameter:handleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
-
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.