require(["esri/rest/support/FindParameters"], (FindParameters) => { /* code goes here */ });
import FindParameters from "@arcgis/core/rest/support/FindParameters.js";
esri/rest/support/FindParameters
Input parameters for find.
- See also
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
Determines whether to look for an exact match of the search text or not. | FindParameters | ||
The name of the class. | Accessor | ||
Specify the geodatabase version to search. | FindParameters | ||
Specify the number of decimal places for the geometries returned by the task. | FindParameters | ||
The layers to perform the find operation on. | FindParameters | ||
The maximum allowable offset used for generalizing geometries returned by the find operation. | FindParameters | ||
The spatial reference of the output geometries. | FindParameters | ||
If | FindParameters | ||
The names of the fields of a layer to search. | FindParameters | ||
The text that is searched across the layers and the fields as specified in the | FindParameters |
Property Details
-
contains
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. Iffalse
, searches for an exact match of the searchText string. The exact match is case-sensitive.- Default Value:true
-
gdbVersion
gdbVersion String
-
Specify the geodatabase version to search.
-
geometryPrecision
geometryPrecision Number
-
Specify the number of decimal places for the geometries returned by the task.
-
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.
ExamplefindParams.layerIds = [0];
-
maxAllowableOffset
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
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
returnGeometry Boolean
-
If
true
, the output will include the geometry associated with each result.- Default Value:false
-
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
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 |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | FindParameters | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | FindParameters |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.