Search

require(["esri/webdoc/applicationProperties/Search"], function(Search) { /* code goes here */ });

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.

Any properties can be set, retrieved or listened to. See the Working with Properties topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Boolean	Indicates whether the place finder is enabled in the web scene or the web map. more details	more details	Search
String	The name of the class. more details	more details	Accessor
Boolean	Whether search functionality is enabled in the web scene or the web map. more details	more details	Search
String	The hint provided with the search dialog. more details	more details	Search
Collection<SearchLayer>	A collection of layers to be included in search. more details	more details	Search
Collection<SearchTable>	A collection of tables to be included in search. more details	more details	Search

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.

Name	Return Type	Summary	Class
	Search	Creates a deep clone of this object. more details	more details	Search

clone(){Search}

Creates a deep clone of this object.

Returns:

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