Represents the search parameters set within the web scene or the web map.
Constructors
-
new Search(properties)
-
Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| Boolean | more details Indicates whether the place finder is enabled in the web scene or the web map. | more details | Search | |
| String | more details The name of the class. | more details | Accessor | |
| Boolean | more details Whether search functionality is enabled in the web scene or the web map. | more details | Search | |
| String | more details The hint provided with the search dialog. | more details | Search | |
| Collection<SearchLayer> | more details A collection of layers to be included in search. | more details | Search | |
| Collection<SearchTable> | more details A collection of tables to be included in search. | more details | Search |
Property Details
-
addressSearchEnabled BooleanSince: ArcGIS API for JavaScript 4.14
-
Indicates whether the place finder is enabled in the web scene or the web map.
-
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.
-
layers Collection<SearchLayer>
-
A collection of layers to be included in search.
-
tables Collection<SearchTable>
-
A collection of tables to be included in search.
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| Search | more details Creates a deep clone of this object. | more details | Search |