require(["esri/rest/support/ImageGPSInfoParameters"], (ImageGPSInfoParameters) => { /* code goes here */ });
import ImageGPSInfoParameters from "@arcgis/core/rest/support/ImageGPSInfoParameters.js";
esri/rest/support/ImageGPSInfoParameters
Image GPS info parameters for ImageryLayer.queryGPSInfo() or imageService.queryGPSInfo() methods.
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| Extent|Multipoint|Point|Polygon|Polyline | The geometry to query images. | ImageGPSInfoParameters | |
| Number[] | 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
-
The geometry to query images. The spatial relationship as specified by spatialRelationship will indicate how the geometry should be used to query images.
-
spatialRelationship
PropertyspatialRelationship 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
PropertytimeExtent TimeExtentautocast -
A time extent for a temporal query to query images.
-
where
Propertywhere 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
-
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
jsonparameter 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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
toJSON
MethodtoJSON(){Object} -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.