Property Overview

Property Details

autoNavigateBoolean inherited

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

Default Value:true

displayFieldString

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

exactMatchBoolean

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

featureLayerFeatureLayer

The feature layer queried in the search. This is required.

Feature layers created from client-side graphics are not supported.

filterObject inherited

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.

maxResultsNumber inherited

Indicates the maximum number of search results to return.

Default Value:6

maxSuggestionsNumber inherited

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

Default Value:6

minSuggestCharactersNumber inherited

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

Default Value:1

nameString

The name of the source for display.

outFieldsString[] inherited

Specifies the fields returned with the search results.

placeholderString inherited

Used as a hint for the source input text.

popupEnabledBoolean inherited

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

popupTemplatePopupTemplate 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.

prefixString inherited

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

resultGraphicEnabledBoolean inherited

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

resultSymbolSymbol inherited

The symbol used to display the result.

searchFieldsString[]

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

searchTemplateString

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

Example:

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

suffixString inherited

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

suggestionsEnabledBoolean inherited

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

Default Value:true

suggestionTemplateString

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:

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

withinViewEnabledBoolean inherited

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

Default Value:false

zoomScaleNumber inherited

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

Method Overview

Method Details

clone(){FeatureLayerSearchSource}

Creates a deep clone of this object.

Returns:

Type	Description
FeatureLayerSearchSource	A clone of the new FeatureLayerSearchSource 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.