ImageGPSInfoParameters | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Image GPS info parameters for ImageryLayer.queryGPSInfo() or imageService.queryGPSInfo() methods.

See also

Constructors

ImageGPSInfoParameters Constructor new ImageGPSInfoParameters(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
Extent\|Multipoint\|Point\|Polygon\|Polyline	The geometry to query images.	ImageGPSInfoParameters
Array<(number\|string)>	An array of ObjectIDs to be used to query images.	ImageGPSInfoParameters
String	For spatial queries, this parameter defines the spatial relationship to query image footprints in the layer against the input geometry.	ImageGPSInfoParameters
TimeExtent	A time extent for a temporal query to query images.	ImageGPSInfoParameters
String	A where clause for the query.	ImageGPSInfoParameters

Property Details

geometry Property geometry Extent |Multipoint |Point |Polygon |Polylineautocast

The geometry to query images. The spatial relationship as specified by spatialRelationship will indicate how the geometry should be used to query images.

objectIds Property objectIds Array<(number|string)>

An array of ObjectIDs to be used to query images.

spatialRelationship Property spatialRelationship String

For spatial queries, this parameter defines the spatial relationship to query image footprints in the layer against the input geometry.

Default Value:"intersects"

timeExtent Property timeExtent TimeExtentautocast

A time extent for a temporal query to query images.

where Property where String

A where clause for the query. Any legal SQL where clause operating on the fields in the layer is allowed.

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

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.