ImageToMapParameters | API Reference | ArcGIS Maps SDK for JavaScript 4.31

ImageToMapParameters

AMD: require(["esri/rest/support/ImageToMapParameters"], (ImageToMapParameters) => { /* code goes here */ });

ESM: import ImageToMapParameters from "@arcgis/core/rest/support/ImageToMapParameters.js";

Class: esri/rest/support/ImageToMapParameters

Since: ArcGIS Maps SDK for JavaScript 4.29

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

See also

Constructors

ImageToMapParameters Constructor new ImageToMapParameters(properties)

Parameter

properties Object

optional

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

Property Overview

Type	Summary	Class
Boolean	When `true`, it will adjust the background vertices to be in the foreground.	ImageToMapParameters
Number	The depth offset.	ImageToMapParameters
Multipoint\|Point\|Polygon\|Polyline	The geometry in an image space.	ImageToMapParameters
SpatialReference	The spatial reference for the output geometry.	ImageToMapParameters
Number	The corresponding raster id for the input geometry.	ImageToMapParameters

Property Details

adjust Property adjust Boolean

When true, it will adjust the background vertices to be in the foreground.

Default Value:false

depthOffset Property depthOffset Number

The depth offset.

Default Value:0

geometry Property geometry Multipoint |Point |Polygon |Polylineautocast

The geometry in an image space.

outSpatialReference Property outSpatialReference SpatialReferenceautocast

The spatial reference for the output geometry. If not specified, the spatial reference of the image service is used.

rasterId Property rasterId Number

The corresponding raster id for the input geometry.

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.	ImageToMapParameters
	Object	Converts an instance of this class to its ArcGIS portal JSON representation.	ImageToMapParameters

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.