require(["esri/webdoc/applicationProperties/Search"], (Search) => { /* code goes here */ });
import Search from "@arcgis/core/webdoc/applicationProperties/Search.js";
esri/webdoc/applicationProperties/Search
Represents the search parameters set within the web scene or the web map.
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 |
|---|---|---|---|
Indicates whether the place finder is enabled in the web scene or the web map. | Search | ||
The name of the class. | Accessor | ||
Whether search functionality is enabled in the web scene or the web map. | Search | ||
The hint provided with the search dialog. | Search | ||
A collection of layers to be included in search. | Search | ||
A collection of tables to be included in search. | Search |
Property Details
-
addressSearchEnabled
PropertyaddressSearchEnabled BooleanSince: ArcGIS Maps SDK for JavaScript 4.14Search since 4.7, addressSearchEnabled added at 4.14. -
Indicates whether the place finder is enabled in the web scene or the web map.
-
enabled
Propertyenabled Boolean -
Whether search functionality is enabled in the web scene or the web map.
-
hintText
PropertyhintText String -
The hint provided with the search dialog.
-
layers
Propertylayers Collection<SearchLayer> -
A collection of layers to be included in search.
-
tables
Propertytables Collection<SearchTable> -
A collection of tables to be included in search.
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 deep clone of this object. | Search | ||
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor |
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.
-
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 trueif 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");