Search

AMD: require(["esri/webdoc/applicationProperties/Search"], (Search) => { /* code goes here */ });
ESM: import Search from "@arcgis/core/webdoc/applicationProperties/Search";
Class: esri/webdoc/applicationProperties/Search
Inheritance: Search Accessor
Since: ArcGIS API for JavaScript 4.7

Represents the search parameters set within the web scene or the web map.

Constructors

new Search(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
Boolean

Indicates whether the place finder is enabled in the web scene or the web map.

more details
Search
String

The name of the class.

more details
Accessor
Boolean

Whether search functionality is enabled in the web scene or the web map.

more details
Search
String

The hint provided with the search dialog.

more details
Search
Collection<SearchLayer>

A collection of layers to be included in search.

more details
Search
Collection<SearchTable>

A collection of tables to be included in search.

more details
Search

Property Details

addressSearchEnabled Boolean
Since: ArcGIS API for JavaScript 4.14

Indicates whether the place finder is enabled in the web scene or the web map.

declaredClass Stringreadonly inherited

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

enabled Boolean

Whether search functionality is enabled in the web scene or the web map.

hintText String

The hint provided with the search dialog.

A collection of layers to be included in search.

A collection of tables to be included in search.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
Search

Creates a deep clone of this object.

more details
Search
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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.

clone(){Search}

Creates a deep clone of this object.

Returns
Type Description
Search Creates a deep clone of the instance calling this method.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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");
}
removeHandles(groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.