FindImagesParameters

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

Input parameter for the ImageryLayer.findImages() or imageService.findImages() methods. The find images operation locates all images that contain toGeometry and sort them accordingly.

See also

Constructors

FindImagesParameters

Constructor
new FindImagesParameters(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

A point geometry with z value.

FindImagesParameters

The maximum image count.

FindImagesParameters

An array of ObjectIDs to filter images.

FindImagesParameters

A point geometry with z value that defines the target geometry's location.

FindImagesParameters

A where clause for the query.

FindImagesParameters

Property Details

fromGeometry

Property
fromGeometry Point

A point geometry with z value. For example, it can be 3D SceneView's camera position.

maxCount

Property
maxCount Number

The maximum image count.

objectIds

Property
objectIds Number[]

An array of ObjectIDs to filter images.

toGeometry

Property
toGeometry Point

A point geometry with z value that defines the target geometry's location. This can be a clicked location on the map.

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.

FindImagesParameters

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

FindImagesParameters

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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.