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
Booleanmore details

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

more detailsSearch
Stringmore details

The name of the class.

more detailsAccessor
Booleanmore details

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

more detailsSearch
Stringmore details

The hint provided with the search dialog.

more detailsSearch
Collection<SearchLayer>more details

A collection of layers to be included in search.

more detailsSearch
Collection<SearchTable>more details

A collection of tables to be included in search.

more detailsSearch

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

Name Return Type Summary Class
Searchmore details

Creates a deep clone of this object.

more detailsSearch

Method Details

clone(){Search}

Creates a deep clone of this object.

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

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