MapToImageParameters

AMD: require(["esri/rest/support/MapToImageParameters"], (MapToImageParameters) => { /* code goes here */ });
ESM: import MapToImageParameters from "@arcgis/core/rest/support/MapToImageParameters.js";
Class: esri/rest/support/MapToImageParameters
Since: ArcGIS Maps SDK for JavaScript 4.29

Input parameters for the ImageryLayer.mapToImage() or imageService.mapToImage() methods.

See also

Constructors

MapToImageParameters

Constructor
new MapToImageParameters(properties)
Parameter
properties Object
optional

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

Property Overview

Name Type Summary Class

The geometry in a map space (coordinates).

MapToImageParameters

The raster id of the raster item corresponding to the input geometry.

MapToImageParameters

When true, the operation will return an empty geometry if the input geometry is not visible.

MapToImageParameters

Property Details

geometry

Property
geometry Extent |Multipoint |Point |Polygon |Polylineautocast

The geometry in a map space (coordinates).

rasterId

Property
rasterId Number

The raster id of the raster item corresponding to the input geometry. The output geometry parameter will use the image coordinate system of the specified raster item.

visibleOnly

Property
visibleOnly 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

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

MapToImageParameters

Method Details

fromJSON

Method
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

Method
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.