FindImagesParameters | References | ArcGIS Maps SDK for JavaScript

import FindImagesParameters from "@arcgis/core/rest/support/FindImagesParameters.js";

Inheritance:: FindImagesParameters→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.29

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

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`FindImagesParametersProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`fromGeometry`	`Point`
`maxCount`	`number \| null \| undefined`
`objectIds`	`ObjectId[] \| null \| undefined`
`toGeometry`	`Point`
`where`	`string \| null \| undefined`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

fromGeometry

autocast Property

Type: Point

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

maxCount

Property

Type: number | null | undefined

The maximum image count.

objectIds

Property

Type: ObjectId[] | null | undefined

An array of ObjectIDs to filter images.

toGeometry

autocast Property

Type: 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

Type: string | null | undefined

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

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone` inherited	`clone(): this`	ClonableMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns: this
A deep clone of the class instance that invoked this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.