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

The Search widget provides a way to perform search operations on locator service(s) and/or map/feature service feature layer(s). If using a locator with a geocoding service, the findAddressCandidates operation is used, whereas queries are used on feature layers.

search

You can use the view's DefaultUI to add widgets to the view's user interface via the ui property on the view. See the example below.

For information about gaining full control of widget styles, see the Styling topic.
See also:
Example:
var searchWidget = new Search({
  view: view
});
// Adds the search widget below other elements in
// the top left corner of the view
view.ui.add(searchWidget, {
  position: "top-left",
  index: 2
});

Constructors

new Search(properties)
Parameter:
properties Object
optional

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

Example:
// typical usage
var search = new Search({
  view: view,
  sources: [ ... ]
});

Property Overview

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

The source object currently selected.

more details
more detailsSearch
Number

The selected source's index.

more details
more detailsSearch
String

String value used as a hint for input text when searching on multiple sources.

more details
more detailsSearch
Boolean

Indicates whether to automatically select and zoom to the first geocoded result.

more details
more detailsSearch
String | HTMLElement

The ID or node representing the DOM element containing the widget.

more details
more detailsWidget
String

The name of the class.

more details
more detailsAccessor
Boolean

When true, this property indicates whether the widget has been destroyed.

more details
more detailsWidget
GoToOverride

This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.

more details
more detailsSearch
String

The widget's default CSS icon class.

more details
more detailsSearch
String

The unique ID assigned to the widget when the widget is created.

more details
more detailsWidget
Boolean | Function

Indicates whether or not to include defaultSources in the Search UI.

more details
more detailsSearch
String

The widget's default label.

more details
more detailsSearch
Boolean

Enables location services within the widget.

more details
more detailsSearch
Number

The maximum number of results returned by the widget if not specified by the source.

more details
more detailsSearch
Number

The maximum number of suggestions returned by the widget if not specified by the source.

more details
more detailsSearch
Number

The minimum number of characters needed for the search if not specified by the source.

more details
more detailsSearch
Boolean

Indicates whether to display the Popup on feature click.

more details
more detailsSearch
PopupTemplate

A customized PopupTemplate for the selected feature.

more details
more detailsSearch
Portal

It is possible to search a specified portal instance's locator services Use this property to set this ArcGIS Portal instance to search.

more details
more detailsSearch
Graphic

The graphic used to highlight the resulting feature or location.

more details
more detailsSearch
Boolean

Indicates if the resultGraphic will display at the location of the selected feature.

more details
more detailsSearch
Object[]

An array of objects, each containing a SearchResult from the search.

more details
more detailsSearch
Boolean

Indicates whether to display the option to search all sources.

more details
more detailsSearch
String

The value of the search box input text string.

more details
more detailsSearch
SearchResult

The result selected from a search.

more details
more detailsSearch
Collection<(FeatureLayerSearchSource|LocatorSearchSource)>

The Search widget may be used to search features in a FeatureLayer or geocode locations with a Locator.

more details
more detailsSearch
SuggestResult[]

An array of results from the suggest method.

more details
more detailsSearch
Boolean

Enable suggestions for the widget.

more details
more detailsSearch
MapView | SceneView

A reference to the MapView or SceneView.

more details
more detailsSearch
SearchViewModel

The view model for this widget.

more details
more detailsSearch

Property Details

The source object currently selected. Can be either a FeatureLayerSearchSource or a esri/widget/Search/LocatorSearchSource.

Default Value:null
activeSourceIndexNumber

The selected source's index. This value is -1 when all sources are selected.

Default Value:0
allPlaceholderString

String value used as a hint for input text when searching on multiple sources. See the image below to view the location and style of this text in the context of the widget.

search-allPlaceholder

Default Value:"Find address or place"
autoSelectBoolean

Indicates whether to automatically select and zoom to the first geocoded result. If false, the findAddressCandidates operation will still geocode the input string, but the top result will not be selected. To work with the geocoded results, you can set up a search-complete event handler and get the results through the event object.

Default Value:true

The ID or node representing the DOM element containing the widget. This property can only be set once.

declaredClassStringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

When true, this property indicates whether the widget has been destroyed.

goToOverrideGoToOverride
Since: ArcGIS API for JavaScript 4.8

This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.

See also:
Example:
// The following snippet uses the Search widget but can be applied to any
// widgets that support the goToOverride property.
search.goToOverride = function(view, goToParams) {
  goToParams.options.duration = updatedDuration;
  return view.goTo(goToParams.target, goToParams.options);
};
iconClassStringreadonly
Since: ArcGIS API for JavaScript 4.7

The widget's default CSS icon class.

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

includeDefaultSourcesBoolean|Function
Since: ArcGIS API for JavaScript 4.8

Indicates whether or not to include defaultSources in the Search UI. This can be a boolean value or a function that returns an array of Search sources.

Default Value:true
labelStringreadonly
Since: ArcGIS API for JavaScript 4.7

The widget's default label.

locationEnabledBoolean
Since: ArcGIS API for JavaScript 4.6

Enables location services within the widget.

locationEnabled

The use of this property is only supported on secure origins. To use it, switch your application to a secure origin, such as HTTPS. Note that localhost is considered "potentially secure" and can be used for easy testing in browsers that supports Window.isSecureContext (currently Chrome and Firefox).

Default Value:true
maxResultsNumber

The maximum number of results returned by the widget if not specified by the source.

Default Value:6
maxSuggestionsNumber

The maximum number of suggestions returned by the widget if not specified by the source.

If working with the default ArcGIS Online Geocoding service, the default remains at 5.

Default Value:6
minSuggestCharactersNumber

The minimum number of characters needed for the search if not specified by the source.

Default Value:1
popupEnabledBoolean

Indicates whether to display the Popup on feature click. The graphic can be clicked to display a Popup.

Default Value:true
popupTemplatePopupTemplate

A customized PopupTemplate for the selected feature. Note that specifying a wildcard {*} for the popupTemplate will return all fields in addition to search-specific fields.

Default Value:null
portalPortal
Since: ArcGIS API for JavaScript 4.8

It is possible to search a specified portal instance's locator services Use this property to set this ArcGIS Portal instance to search.

resultGraphicGraphicreadonly

The graphic used to highlight the resulting feature or location.

A graphic will be placed in the View's graphics for layer views that do not support the highlight method.

resultGraphicEnabledBoolean

Indicates if the resultGraphic will display at the location of the selected feature.

Default Value:true
resultsObject[]readonly

An array of objects, each containing a SearchResult from the search.

searchAllEnabledBoolean

Indicates whether to display the option to search all sources. When true, the "All" option is displayed by default:

search-searchAllEnabled-true

When false, no option to search all sources at once is available:

search-searchAllEnabled-false

Default Value:true
searchTermString

The value of the search box input text string.

selectedResultSearchResultreadonly

The result selected from a search.

See also:

The Search widget may be used to search features in a FeatureLayer or geocode locations with a Locator. The sources property defines the sources from which to search for the view specified by the Search widget instance. There are two types of sources:

Any combination of these sources may be used together in the same instance of the Search widget.

Examples:
// Default sources[] when sources is not specified
[
  {
    locator: new Locator({ url: "https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer" }),
    singleLineFieldName: "SingleLine",
    outFields: ["Addr_type"],
    name: "ArcGIS World Geocoding Service",
    localSearchOptions: {
      minScale: 300000,
      distance: 50000
    },
    placeholder: i18n.placeholder,
    resultSymbol: {
       type: "picture-marker",  // autocasts as new PictureMarkerSymbol()
       url: this.basePath + "/images/search/search-symbol-32.png",
       size: 24,
       width: 24,
       height: 24,
       xoffset: 0,
       yoffset: 0
   }
  }
]
// Example of multiple sources[]
var sources = [
{
  locator: new Locator({ url: "https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer" }),
  singleLineFieldName: "SingleLine",
  name: "Custom Geocoding Service",
  localSearchOptions: {
    minScale: 300000,
    distance: 50000
  },
  placeholder: "Search Geocoder",
  maxResults: 3,
  maxSuggestions: 6,
  suggestionsEnabled: false,
  minSuggestCharacters: 0
}, {
  featureLayer: new FeatureLayer({
    url: "https://services.arcgis.com/DO4gTjwJVIJ7O9Ca/arcgis/rest/services/GeoForm_Survey_v11_live/FeatureServer/0",
    outFields: ["*"]
  }),
  searchFields: ["Email", "URL"],
  displayField: "Email",
  exactMatch: false,
  outFields: ["*"],
  name: "Point FS",
  placeholder: "example: esri",
  maxResults: 6,
  maxSuggestions: 6,
  suggestionsEnabled: true,
  minSuggestCharacters: 0
},
{
  featureLayer: new FeatureLayer({
    outFields: ["*"]
  }),
  placeholder: "esri",
  name: "A FeatureLayer",
  prefix: "",
  suffix: "",
  maxResults: 1,
  maxSuggestions: 6,
  exactMatch: false,
  searchFields: [], // defaults to FeatureLayer.displayField
  displayField: "", // defaults to FeatureLayer.displayField
  minSuggestCharacters: 0
}
];
// Set source(s) on creation
var searchWidget = new Search({
  sources: []
});
// Set source(s)
var searchWidget = new Search();
var sources = [{ ... }, { ... }, { ... }]; //array of sources
searchWidget.sources = sources;
// Add to source(s)
var searchWidget = new Search();
searchWidget.sources.push({ ... });  //new source
suggestionsSuggestResult[]readonly

An array of results from the suggest method.

This is available if working with a 10.3 or greater geocoding service that has suggest capability loaded or a 10.3 or greater feature layer that supports pagination, i.e. supportsPagination = true.

suggestionsEnabledBoolean

Enable suggestions for the widget.

This is only available if working with a 10.3 or greater geocoding service that has suggest capability loaded or a 10.3 or greater feature layer that supports pagination, i.e. supportsPagination = true.

Default Value:true

A reference to the MapView or SceneView. Set this to link the widget to a specific view.

The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the SearchViewModel class to access all properties and methods on the widget.

Method Overview

NameReturn TypeSummaryClass

Unfocuses the widget's text input.

more details
more detailsSearch
String

A utility method used for building the value for a widget's class property.

more details
more detailsWidget

Clears the current searchTerm, search results, suggest results, graphic, and graphics layer.

more details
more detailsSearch

Destroys the widget instance.

more details
more detailsWidget

Emits an event on the instance.

more details
more detailsWidget

Brings focus to the widget's text input.

more details
more detailsSearch
Boolean

Indicates whether there is an event listener on the instance that matches the provided event name.

more details
more detailsWidget
Object

Registers an event handler on the instance.

more details
more detailsWidget

Widget teardown helper.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget
Object

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Renders widget to the DOM immediately.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget
Promise<SearchResponse>

Depending on the sources specified, search() queries the feature layer(s) and/or performs address matching using any specified Locator(s) and returns any applicable results.

more details
more detailsSearch

Deprecated.

more details
more detailsWidget
Promise<SuggestResponse>

Performs a suggest() request on the active Locator.

more details
more detailsSearch

Method Details

blur()

Unfocuses the widget's text input.

classes(classNames){String}inherited
Since: ArcGIS API for JavaScript 4.7

A utility method used for building the value for a widget's class property. This aids in simplifying CSS class setup.

Prior to version 4.7, there were various approaches towards setting CSS classes. These were dependent upon variables, such as whether the classes were:

  • a single static class,
  • multiple static classes, or
  • dynamic classes.

This helper method takes all of these approaches into account and simplifies it to use one single pattern to accommodate these multiple approaches.

Parameter:
classNames Array<(String|String[]|Object)>
repeatable

The class names.

Returns:
TypeDescription
StringThe computed class name.
See also:
Example:
// .tsx syntax showing how to set CSS classes while rendering the widget
render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

  return (
    <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} />
  );
}
clear()

Clears the current searchTerm, search results, suggest results, graphic, and graphics layer. It also hides any open menus.

destroy()inherited

Destroys the widget instance.

emit(type, event)inherited
Since: ArcGIS API for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters:
type String

The name of the event.

event Object

The event payload.

focus()

Brings focus to the widget's text input.

hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:
type String

The name of the event.

Returns:
TypeDescription
BooleanReturns true if the class supports the input event.
on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters:
type String

The name of event to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event.
PropertyTypeDescription
removeFunctionWhen called, removes the listener from the event.
See also:
Example:
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});
own(handles)inherited

Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.

Parameter:

Handles marked for removal once the widget is destroyed.

postInitialize()inherited

This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:
TypeDescription
ObjectThe rendered virtual node.
renderNow()inherited

Renders widget to the DOM immediately.

scheduleRender()inherited

This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.

Depending on the sources specified, search() queries the feature layer(s) and/or performs address matching using any specified Locator(s) and returns any applicable results.

Parameter:
optional

This searchTerm can be a string, geometry, suggest candidate object, or an array of [longitude,latitude] coordinate pairs. If a geometry is supplied, then it will reverse geocode (locator) or findAddressCandidates with geometry instead of text.

Returns:
TypeDescription
Promise<SearchResponse>When resolved, returns a SearchResponse containing a SearchResult.
startup()inherited
Deprecated
  • since version 4.2.

Deprecated. Finalizes the creation of the widget.

suggest(value){Promise<SuggestResponse>}

Performs a suggest() request on the active Locator. It also uses the current value of the widget or one that is passed in.

Suggestions are available if working with a 10.3 or greater geocoding service that has suggest capability loaded or a 10.3 or greater feature layer that supports pagination, i.e. supportsPagination = true.

Parameter:
value String
optional

The string value used to suggest() on an active Locator or feature layer. If nothing is passed in, takes the current value of the widget.

Returns:
TypeDescription
Promise<SuggestResponse>When resolved, returns SuggestResponse containing an array of result objects. Each of these results contains a SuggestResult.

Type Definitions

SearchResponse

When resolved, returns this response after calling search.

Properties:
activeSourceIndex Number

The index of the source from which the search result was obtained.

errors Error[]

An array of error objects returned from the search results.

numResults Number

The number of search results.

searchTerm String

The searched expression

results Object[]

An array of objects representing the results of search. See object specification table below for more information about the result object.

Specification:

An array of search results.

sourceIndex Number

The index of the currently selected source.

source Object

The source of the selected result.

SearchResult

The result object returned from a search().

Properties:
extent Extent

The extent, or bounding box, of the returned feature.

feature Graphic

The resulting feature or location obtained from the search.

name String

The name of the result.

SuggestResponse

When resolved, returns this response after calling suggest.

Properties:
activeSourceIndex Number

The index of the source from which suggestions are obtained. This value is -1 when all sources are selected.

errors Error[]

An array of error objects returned from the suggest results.

numResults Number

The number of suggest results.

searchTerm String

The search expression used for the suggest.

results Object[]

An array of objects representing the results of suggest. See object specification table below for more information about the result object.

Specification:

An array of suggest results.

sourceIndex Number

The index of the currently selected source.

source Object

The source of the selected result.

SuggestResult

The result object returned from a suggest().

Properties:
key String

The key related to the suggest result.

text String

The string name of the suggested location to geocode.

sourceIndex Number

The index of the currently selected result.

Event Overview

NameTypeSummaryClass

Fires when the widget's text input loses focus.

more details
more detailsSearch

Fires when a result is cleared from the input box or a new result is selected.

more details
more detailsSearch
{activeSourceIndex: Number,errors: Error[],numResults: Number,searchTerm: String,results: Object[],}

Fires when the search() method is called and returns its results.

more details
more detailsSearch

Fires when the widget's text input sets focus.

more details
more detailsSearch

Fires when the search() method starts.

more details
more detailsSearch
{result: Object,source: Object,sourceIndex: Number}

Fires when a search result is selected.

more details
more detailsSearch
{activeSourceIndex: Number,errors: Error[],numResults: Number,searchTerm: String,results: Object[],}

Fires when the suggest method is called and returns its results.

more details
more detailsSearch

Fires when the suggest() method starts.

more details
more detailsSearch

Event Details

search-blur

Fires when the widget's text input loses focus.

Example:
var searchWidget = new Search();

searchWidget.on("search-blur", function(event){
  console.log("Focus removed from search input textbox.");
});
search-clear

Fires when a result is cleared from the input box or a new result is selected.

Example:
var searchWidget = new Search();

searchWidget.on("search-clear", function(event){
  console.log("Search input textbox was cleared.");
});
search-complete

Fires when the search() method is called and returns its results.

Properties:
activeSourceIndex Number

The index of the source from which the search result was obtained.

errors Error[]

An array of error objects returned from the search results.

numResults Number

The number of results from the search.

searchTerm String

The searched expression.

results Object[]

An array of objects representing the results of the search. See object specification table below for more information about the result object.

Specification:

An array of objects containing the search results.

sourceIndex Number

The index of the currently selected source.

source Object

The source of the selected result.

Example:
var searchWidget = new Search();

searchWidget.on("search-complete", function(event){
  // The results are stored in the event Object[]
  console.log("Results of the search: ", event);
});
search-focus

Fires when the widget's text input sets focus.

Example:
var searchWidget = new Search();

searchWidget.on("search-focus", function(event){
  console.log("Search input textbox is focused.");
});
search-start

Fires when the search() method starts.

Example:
var searchWidget = new Search();

searchWidget.on("search-start", function(event){
  console.log("Search started.");
});
select-result

Fires when a search result is selected.

Properties:
result Object

An object containing the results of the search.

Specification:
extent Extent

The extent of the result to zoom to.

feature Graphic

The graphic feature to place at the location of the search result.

name String

The string name of the geocoded location.

source Object

The source of the selected result. Please see sources for additional information on its properties.

sourceIndex Number

The index of the source of the selected result.

Example:
var searchWidget = new Search();

searchWidget.on("select-result", function(event){
  console.log("The selected search result: ", event);
});
suggest-complete

Fires when the suggest method is called and returns its results.

Properties:
activeSourceIndex Number

The index of the source from which suggestions are obtained. This value is -1 when all sources are selected.

errors Error[]

An array of error objects returned from the suggest results.

numResults Number

The number of suggest results.

searchTerm String

The search expression used for the suggest.

results Object[]

An array of objects representing the results of suggest. See object specification table below for more information on this object.

Specification:

An array of objects containing the suggest results.

sourceIndex Number

The index of the currently selected source.

source Object

The source of the selected result.

Example:
var searchWidget = new Search();

searchWidget.on("suggest-complete", function(event){
  // The results are stored in the event Object[]
  console.log("Results of suggest: ", event);
});
suggest-start

Fires when the suggest() method starts.

Example:
var searchWidget = new Search();

searchWidget.on("suggest-start", function(event){
  console.log("suggest-start", event);
});

API Reference search results

NameTypeModule
Loading...