FindParameters

AMD: require(["esri/tasks/support/FindParameters"], (FindParameters) => { /* code goes here */ });
ESM: import FindParameters from "@arcgis/core/tasks/support/FindParameters";
Class: esri/tasks/support/FindParameters
Inheritance: FindParameters Accessor
Since: ArcGIS API for JavaScript 4.0
Deprecated since version 4.20. Use FindParameters instead.

Input parameters for FindTask.

See also:

Constructors

new FindParameters(properties)
Parameter:
properties Object
optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Booleanmore details

Determines whether to look for an exact match of the search text or not.

more detailsFindParameters
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

Specify the geodatabase version to search.

more detailsFindParameters
Numbermore details

Specify the number of decimal places for the geometries returned by the task.

more detailsFindParameters
Number[]more details

The layers to perform the find operation on.

more detailsFindParameters
Numbermore details

The maximum allowable offset used for generalizing geometries returned by the find operation.

more detailsFindParameters
SpatialReferencemore details

The spatial reference of the output geometries.

more detailsFindParameters
Booleanmore details

If true, the output will include the geometry associated with each result.

more detailsFindParameters
String[]more details

The names of the fields of a layer to search.

more detailsFindParameters
Stringmore details

The text that is searched across the layers and the fields as specified in the layers and searchFields properties.

more detailsFindParameters

Property Details

contains 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
declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

gdbVersion String

Specify the geodatabase version to search.

geometryPrecision Number

Specify the number of decimal places for the geometries returned by the task.

layerIds Number[]

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 Number

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 SpatialReference

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 Boolean

If true, the output will include the geometry associated with each result.

Default Value:false
searchFields String[]

The names of the fields of a layer to search. The fields are specified as a comma-separated list of field names. If this parameter is not specified, all fields are searched by default.

searchText String

The text that is searched across the layers and the fields as specified in the layers and searchFields properties.

Method Overview

Name Return Type Summary Class
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsFindParameters
Objectmore details

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

more detailsFindParameters

Method Details

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(){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.