Skip To ContentArcGIS for DevelopersSign In Dashboard

LocatorSearchSource

require(["esri/widgets/Search/LocatorSearchSource"], function(LocatorSearchSource) { /* code goes here */ });
Class: esri/widgets/Search/LocatorSearchSource
Inheritance: LocatorSearchSource SearchSource
Since: ArcGIS API for JavaScript 4.0

The following properties define a source pointing to a Locator that may be used to geocode locations with a Search widget instance.

See also:

Constructors

new LocatorSearchSource(properties)
Parameter:
properties Object
optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
Boolean

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

more details
more detailsSearchSource
String[]

A string array which limits the results to one or more categories.

more details
more detailsLocatorSearchSource
String

Constricts search results to a specified country code.

more details
more detailsLocatorSearchSource
Number

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

more details
more detailsLocatorSearchSource
Object

This property replaces the now deprecated searchQueryParams, suggestQueryParams, and searchExtent properties.

more details
more detailsLocatorSearchSource
GetResultsHandler

Function used to get search results.

more details
more detailsSearchSource
GetSuggestionsParameters

Function used to get search suggestions.

more details
more detailsSearchSource
String

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

more details
more detailsLocatorSearchSource
Locator

The locator task used to search.

more details
more detailsLocatorSearchSource
Number

Indicates the maximum number of search results to return.

more details
more detailsSearchSource
Number

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

more details
more detailsSearchSource
Number

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

more details
more detailsSearchSource
String

The name of the source for display.

more details
more detailsLocatorSearchSource
String[]

Specifies the fields returned with the search results.

more details
more detailsSearchSource
String

Used as a hint for the source input text.

more details
more detailsLocatorSearchSource
Boolean

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

more details
more detailsSearchSource
PopupTemplate

The popup template used to display search results.

more details
more detailsSearchSource
String

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

more details
more detailsSearchSource
Boolean

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

more details
more detailsSearchSource
Symbol

The symbol used to display the result.

more details
more detailsSearchSource
String

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

more details
more detailsLocatorSearchSource
String

The field name of the Single Line Address Field in the REST services directory for the locator service.

more details
more detailsLocatorSearchSource
String

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

more details
more detailsSearchSource
Boolean

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

more details
more detailsLocatorSearchSource
Boolean

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

more details
more detailsSearchSource
Number

The set zoom scale for the resulting search result.

more details
more detailsLocatorSearchSource

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:
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:
defaultZoomScale Number
Since: ArcGIS API for JavaScript 4.13

Sets the scale of the MapView or SceneView for the resulting search result, if the locator service doesn’t return an extent with a scale. An example of this is using the Use current location option in the Search bar.

If you want to override the scale returned by the locator service, use zoomScale instead.

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

Property:
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.

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:

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:
locationType String
Since: ArcGIS API for JavaScript 4.12

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

Possible Values:"rooftop"|"street"

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.

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.

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.

Known Limitations

This property only applies when the layer/locator/source is not part of the map.

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.

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:null
Example:
var searchWidget = new Search({
  view: view,
  includeDefaultSources: false,
  sources: [
    {
      locator: new Locator({
        url: "https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer"
      }),
      name: "LocatorSearchSource",
      zoomScale: 500000
    }
  ]
});

Method Overview

NameReturn TypeSummaryClass
LocatorSearchSource

Creates a deep clone of this object.

more details
more detailsLocatorSearchSource
*

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform.

more details
more detailsLocatorSearchSource
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
more detailsLocatorSearchSource

Method Details

Creates a deep clone of this object.

Returns:
TypeDescription
LocatorSearchSourceA 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:
TypeDescription
*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() guide topic for more information.

Returns:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...