Property Overview

Property Details

autoNavigate Boolean

Indicates whether to automatically navigate to the selected result once selected.

Default Value:true

filter Object

Since: ArcGIS API for JavaScript 4.4

This property replaces the now deprecated searchQueryParams, suggestQueryParams, and searchExtent properties. Please see the object specification table below for details.

Properties:

where String optional The where clause specified for filtering suggests or search results.

geometry Geometry optional The filter geometry for suggests or search results. Extent is the only supported geometry when working with locator sources. See Find Address Candidates for additional information.

getResults GetResultsHandler

Function used to get search results. See GetResultsHandler for the function definition. When resolved, returns an object containing an array of search results.

Default Value:null

See also:

• Sample - Search widget with custom source

getSuggestions GetSuggestionsParameters

Function used to get search suggestions. See GetSuggestionsParameters for the function definition. When resolved, returns an object containing an array of suggest results.

Default Value:null

See also:

• Sample - Search widget with custom source

maxResults Number

Indicates the maximum number of search results to return.

Default Value:6

maxSuggestions Number

Indicates the maximum number of suggestions to return for the widget's input.

Default Value:6

minSuggestCharacters Number

Indicates the minimum number of characters required before querying for a suggestion.

Default Value:1

outFields String[]

Specifies the fields returned with the search results.

placeholder String

Used as a hint for the source input text.

popupEnabled Boolean

Indicates whether to display a Popup when a selected result is clicked.

popupTemplate PopupTemplate

The popup template used to display search results. If no popup is needed, set the source's popupTemplate to null.

This property should be set in instances where there is no existing PopupTemplate configured. For example, feature sources will default to any existing popupTemplate configured on the layer.

prefix String

Specify this to prefix the user's input of the search text.

resultGraphicEnabled Boolean

Indicates whether to show a graphic on the map for the selected source using the resultSymbol.

resultSymbol Symbol

The symbol used to display the result.

suffix String

Specify this to add a suffix to the user's input for the search value.

suggestionsEnabled Boolean

Indicates whether to display suggestions as the user enters input text in the widget.

Default Value:true

withinViewEnabled Boolean

Indicates whether to constrain the search results to the view's extent.

Default Value:false

zoomScale Number

The set zoom scale for the resulting search result. This scale is automatically honored.

Method Overview

Method Details

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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.

Parameter:

json Object 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:

Type	Description
*	Returns a new instance of this class.

toJSON(){Object}

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

Returns:

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.

Type Definitions

GetResultsHandler(params){Promise<SearchResult[]>}

Function definition for the getResults property.

Parameters:

Specification:

params Object An object that is passed as a parameter to get search results. Specification: exactMatch Boolean optional The key field used to find the result. location Point optional The location value used by the Search. maxResults Number optional Indicates the maximum number of search results to return. sourceIndex Number optional Indicates the index of the search source. spatialReference SpatialReference optional Indicates the Spatial Reference defined by the source. suggestResult SuggestResult Indicates the Suggest Result that triggered the search for a result. view MapView|SceneView optional Indicates the view provided to the Search Widget using the source.

Returns:

Type	Description
Promise<SearchResult[]>	When resolved, returns an object containing an array of search results.

GetSuggestionsParameters(params){Promise<SuggestResult[]>}

Function definition for the getSuggestions() property.

Parameters:

Specification:

params Object An object that is passed as a parameter to get search suggestions. Specification: maxSuggestions Number optional Indicates the maximum number of suggestions to return for the widget's input. sourceIndex Number optional Indicates the index of the search source. spatialReference SpatialReference optional Indicates the Spatial Refeference defined by the source. suggestTerm String optional Indicates search term used to find a suggestion. view MapView|SceneView optional Indicates the view provided to the Search Widget using the source.

Returns:

Type	Description
Promise<SuggestResult[]>	When resolved, returns an object containing an array of suggest results.