Property Overview

Property Details

autoNavigate Boolean inherited

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

Default Value:true

displayField String

The results are displayed using this field. Defaults to the layer's displayField or the first string field.

exactMatch Boolean

Indicates to only return results that match the search value exactly. This property only applies to string field searches. exactMatch is always true when searching fields of type number.

Default Value:false

filter Object inherited

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 inherited

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 inherited

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

layer Layer

The layer queried in the search. This is required.

Layers created from client-side graphics are not supported.

maxResults Number inherited

Indicates the maximum number of search results to return.

Default Value:6

maxSuggestions Number inherited

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

Default Value:6

minSuggestCharacters Number inherited

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

Default Value:1

name String

The name of the source for display.

orderByFields String[]inner

One or more field names used to order the query results. Specfiy ASC (ascending) or DESC (descending) after the field name to control the order. The default order is ASC.

outFields String[] inherited

Specifies the fields returned with the search results.

placeholder String inherited

Used as a hint for the source input text.

popupEnabled Boolean inherited

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

popupTemplate PopupTemplate inherited

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 inherited

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

resultGraphicEnabled Boolean inherited

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

resultSymbol Symbol inherited

The symbol used to display the result.

searchFields String[]

An array of string values representing the names of fields in the feature layer to search.

searchTemplate String

A template string used to display multiple fields in a defined order when results are displayed.

Example:

LayerSearchSource.searchTemplate = "{County}, {State}";

suffix String inherited

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

suggestionsEnabled Boolean inherited

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

Default Value:true

suggestionTemplate String

A template string used to display multiple fields in a defined order when suggestions are displayed. This takes precedence over displayField. Field names in the template must have the following format: {FieldName}. An example suggestionTemplate could look something like: Name: {OWNER}, Parcel: {PARCEL_ID}.

Example:

LayerSearchSource.suggestionTemplate = "Name: {OWNER}, Parcel: {PARCEL_ID}";

withinViewEnabled Boolean inherited

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

Default Value:false

zoomScale Number inherited

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

Method Overview

Method Details

clone(){LayerSearchSource}

Creates a deep clone of this object.

Returns:

Type	Description
LayerSearchSource	A clone of the new LayerSearchSource instance.

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.