import FindParameters from "@arcgis/core/rest/support/FindParameters.js";const FindParameters = await $arcgis.import("@arcgis/core/rest/support/FindParameters.js");- Inheritance:
- FindParameters→
Accessor
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
| | ||
declaredClass readonly inherited | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| |
contains
- Type
- boolean
Determines whether to look for an exact match of the search text or not.
If true, searches for a value that contains the provided searchText. This is a case-insensitive search.
If false, searches for an exact match of the searchText string. The exact match is case-sensitive.
- Default value
- true
layerIds
The layers to perform the find operation on. The layers are specified as a comma-separated list of layer ids. The list of ids is returned in MapImageLayer layerInfos.
Example
findParams.layerIds = [0]; maxAllowableOffset
The maximum allowable offset used for generalizing geometries returned by the find operation. The offset is in the units of outSpatialReference. If outSpatialReference is not defined, the spatial reference of the map is used.
outSpatialReference
- Type
- SpatialReference | null | undefined
The spatial reference of the output geometries. If this is not specified, the output geometries are returned in the spatial reference of the map.
returnGeometry
- Type
- boolean
If true, the output will include the geometry associated with each result.
- Default value
- false
searchText
The text that is searched across the layers and the fields as specified in the layers and
searchFields properties.
Methods
fromJSON
- Signature
-
fromJSON (json: any): any
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 | 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.
toJSON
- Signature
-
toJSON (): any
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.