FindParameters

require(["esri/tasks/support/FindParameters"], function(FindParameters) { /* code goes here */ });
Class: esri/tasks/support/FindParameters
Inheritance: FindParameters Accessor
Since: ArcGIS API for JavaScript 4.0

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.
NameTypeSummaryClass
Boolean

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

more details
more detailsFindParameters
String

The name of the class.

more details
more detailsAccessor
Number

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

more details
more detailsFindParameters
Number[]

The layers to perform the find operation on.

more details
more detailsFindParameters
Number

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

more details
more detailsFindParameters
SpatialReference

The spatial reference of the output geometries.

more details
more detailsFindParameters
Boolean

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

more details
more detailsFindParameters
String[]

The names of the fields of a layer to search.

more details
more detailsFindParameters
String

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

more details
more detailsFindParameters

Property Details

containsBoolean

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

declaredClassStringreadonly inherited

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

geometryPrecisionNumber

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

layerIdsNumber[]

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];

maxAllowableOffsetNumber

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.

outSpatialReferenceSpatialReference

The spatial reference of the output geometries. If this is not specified, the output geometries are returned in the spatial reference of the map.

returnGeometryBoolean

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

Default Value: false

searchFieldsString[]

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.

searchTextString

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

Method Overview

NameReturn TypeSummaryClass
Object

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

more details
more detailsFindParameters

Method Details

toJSON(){Object}

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

Returns:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.