Property Overview

Property Details

autoNavigate Boolean inherited

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

Default Value:true

categories String[]

A string array which limits the results to one or more categories. For example, Populated Place or airport. Only applicable when using the World Geocode Service.

See also:

• World Geocode Service documentation

countryCode String

Constricts search results to a specified country code. For example, US for United States or SE for Sweden. Only applies to the World Geocode Service.

See also:

• World Geocode Service documentation

defaultZoomScale Number

Since: ArcGIS API for JavaScript 4.13

Sets the scale of the MapView or SceneView for the resulting search result. This is useful if the locator service doesn’t return an extent with a scale.

Default Value:null

Example:

// create the Search widget
var searchWidget = new Search({
  view: view
});

// wait for the widget to be ready to set the defaultZoomScale
searchWidget.watch("viewModel.state", function(state) {
  if (state === "ready") {
    var firstSource = searchWidget.allSources.getItemAt(0);
    if (firstSource) {
      firstSource.defaultZoomScale = 100000;
    }
  }
});

filter Object 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. 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

locationType String

Since: ArcGIS API for JavaScript 4.12

Define the type of location, either "street" or "rooftop", of the point returned from the World Geocoding Service.

Possible Values: rooftop | street | null

Default Value:null

Example:

// create the Search widget
var searchWidget = new Search({
  view: view
});

// wait for the widget to be ready to set the locationType
searchWidget.watch("viewModel.state", function(state) {
  if (state === "ready") {
    var firstSource = searchWidget.allSources.getItemAt(0);
    if (firstSource) {
      firstSource.locationType = "rooftop";
    }
  }
});

locator Locator

The locator task used to search. This is required and defaults to the World Geocoding Service.

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.

outFields String[] inherited

Specifies the fields returned with the search results.

placeholder String

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.

searchTemplate String

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

Example:

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

singleLineFieldName String

The field name of the Single Line Address Field in the REST services directory for the locator service. Common values are SingleLine and SingleLineFieldName.

suffix String inherited

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 inherited

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.

Default Value:true

Method Overview

Method Details

clone(){LocatorSearchSource}

Creates a deep clone of this object.

Returns:

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