ImageUrlParameters | API Reference | ArcGIS Maps SDK for JavaScript 4.31

ImageUrlParameters

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

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

Class: esri/rest/support/ImageUrlParameters

Since: ArcGIS Maps SDK for JavaScript 4.30

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

See also

Constructors

ImageUrlParameters Constructor new ImageUrlParameters(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
	Number	The raster's object id.	ImageUrlParameters
	String	The relative reference to the image's uri.	ImageUrlParameters

Property Details

rasterId Property rasterId Number

The raster's object id. The raster object id can be obtained using the imageService.findImages() or ImageryLayer.findImages() method.

referenceUri Property referenceUri String

The relative reference to the image's uri. The reference uri can be obtained using the imageService.findImages() or ImageryLayer.findImages() method.

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

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.