require(["esri/rest/support/MapToImageParameters"], (MapToImageParameters) => { /* code goes here */ });
import MapToImageParameters from "@arcgis/core/rest/support/MapToImageParameters.js";
esri/rest/support/MapToImageParameters
Input parameters for the ImageryLayer.mapToImage() or imageService.mapToImage() methods.
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| Extent|Multipoint|Point|Polygon|Polyline | The geometry in a map space (coordinates). | MapToImageParameters | |
| Number | The raster id of the raster item corresponding to the input geometry. | MapToImageParameters | |
| Boolean | When | MapToImageParameters |
Property Details
-
The geometry in a map space (coordinates).
-
visibleOnly
PropertyvisibleOnly Boolean -
When
true, the operation will return an empty geometry if the input geometry is not visible.- Default Value:false
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | MapToImageParameters | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. | MapToImageParameters |
Method Details
-
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.Parameterjson 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.
ReturnsType Description * Returns a new instance of this class.
-
toJSON
MethodtoJSON(){Object} -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.