require(["esri/rest/support/FindImagesParameters"], (FindImagesParameters) => { /* code goes here */ });
import FindImagesParameters from "@arcgis/core/rest/support/FindImagesParameters.js";
esri/rest/support/FindImagesParameters
Input parameter for the ImageryLayer.findImages() or imageService.findImages() methods. The find images operation locates all images that contain toGeometry and sort them accordingly.
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 |
|---|---|---|---|
| Point | A point geometry with | FindImagesParameters | |
| Number | The maximum image count. | FindImagesParameters | |
| Number[] | An array of ObjectIDs to filter images. | FindImagesParameters | |
| Point | A point geometry with | FindImagesParameters | |
| String | A where clause for the query. | FindImagesParameters |
Property Details
-
fromGeometry
PropertyfromGeometry Point -
A point geometry with
zvalue. For example, it can be 3D SceneView's camera position.
-
maxCount
PropertymaxCount Number -
The maximum image count.
-
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. | FindImagesParameters | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. | FindImagesParameters |
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.