Search | References | ArcGIS Maps SDK for JavaScript

import Search from "@arcgis/core/webdoc/applicationProperties/Search.js";

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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`SearchProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`addressSearchEnabled`	`boolean`
`declaredClass` readonly inherited	`string`	Accessor
`enabled`	`boolean`
`hintText`	`string \| null \| undefined`
`layers`	`Collection<SearchLayer>`
`tables`	`Collection<SearchTable>`

addressSearchEnabled

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 4.14

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

Default value: true

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

enabled

Property

Type: boolean

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

Default value: true

hintText

Property

Type: string | null | undefined

The hint provided with the search dialog.

layers

autocast Property

Type: Collection<SearchLayer>

A collection of layers to be included in search.

tables

autocast Property

Type: Collection<SearchTable>

A collection of tables to be included in search.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): Search`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameters

Parameter	Type	Description	Required
json	`any`	A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns: any
Returns a new instance of this class.

clone

Method

Signature: clone (): Search

Creates a deep clone of this object.

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

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.