Skip To ContentArcGIS for DevelopersSign In Dashboard
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.

Property Overview

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

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

more details
more detailsSearch
String

The name of the class.

more details
more detailsAccessor
Boolean

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

more details
more detailsSearch
String

The hint provided with the search dialog.

more details
more detailsSearch
Collection<SearchLayer>

A collection of layers to be included in search.

more details
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.

Method Overview

NameReturn TypeSummaryClass
Search

Creates a deep clone of this object.

more details
more detailsSearch

Method Details

clone(){Search}

Creates a deep clone of this object.

Returns:
TypeDescription
SearchCreates a deep clone of the instance calling this method.

API Reference search results

NameTypeModule
Loading...