Search

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

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

Constructors

Search

Constructor
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

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

Property
addressSearchEnabled Boolean
Since: ArcGIS Maps SDK for JavaScript 4.14 Search since 4.7, addressSearchEnabled added at 4.14.

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

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

enabled

Property
enabled Boolean

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

hintText

Property
hintText String

The hint provided with the search dialog.

layers

Property
layers Collection<SearchLayer>

A collection of layers to be included in search.

tables

Property
tables Collection<SearchTable>

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.

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

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();
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

Method
clone(){Search}

Creates a deep clone of this object.

Returns
Type Description
Search Creates a deep clone of the instance calling this method.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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.