ImageGPSInfoParameters

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

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

Name Type Summary Class

The geometry to query images.

ImageGPSInfoParameters

An array of ObjectIDs to be used to query images.

ImageGPSInfoParameters

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

ImageGPSInfoParameters

A time extent for a temporal query to query images.

ImageGPSInfoParameters

A where clause for the query.

ImageGPSInfoParameters

Property Details

geometry

Property
geometry Extent |Multipoint |Point |Polygon |Polyline |null |undefinedautocast

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)> |null |undefined

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.

Possible Values:"intersects" |"contains" |"crosses" |"disjoint" |"envelope-intersects" |"index-intersects" |"overlaps" |"touches" |"within" |"relation"

Default Value:"intersects"

timeExtent

Property
timeExtent TimeExtent |null |undefinedautocast

A time extent for a temporal query to query images.

where

Property
where String |null |undefined

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

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

ImageGPSInfoParameters

Method Details

fromJSON

Method
fromJSON(json){* |null |undefined}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
* | null | undefined 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.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close