SearchViewModel

AMD: require(["esri/widgets/Search/SearchViewModel"], (SearchVM) => { /* code goes here */ });
ESM: import SearchVM from "@arcgis/core/widgets/Search/SearchViewModel.js";
Class: esri/widgets/Search/SearchViewModel
Inheritance: SearchViewModel Accessor
Since: ArcGIS Maps SDK for JavaScript 4.0

Provides the logic for the Search widget, which performs search operations on locator service(s), map/feature service feature layer(s), and/or table(s). If using a locator with a geocoding service, the findAddressCandidates operation is used, whereas queries are used on feature layers.

See also

Constructors

new SearchViewModel(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.
Show inherited properties Hide inherited properties
Name Type Summary Class
LayerSearchSource|LocatorSearchSource

The source object currently selected.

more details
SearchViewModel
Number

The selected source's index.

more details
SearchViewModel
String

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

more details
SearchViewModel
Collection<(LayerSearchSource|LocatorSearchSource)>

The combined collection of defaultSources and sources.

more details
SearchViewModel
Boolean

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

more details
SearchViewModel
String

The name of the class.

more details
Accessor
Collection<(LayerSearchSource|LocatorSearchSource)>

A read-only property that is a Collection of LayerSearchSource and/or LocatorSearchSource.

more details
SearchViewModel
Object

The default symbol(s) for the search result.

more details
SearchViewModel
GoToOverride

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

more details
SearchViewModel
Boolean|Function

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

more details
SearchViewModel
Boolean

Indicates whether location services are enabled within the widget.

more details
SearchViewModel
Number

The maximum character length of the search text.

more details
SearchViewModel
Number

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

more details
SearchViewModel
Number

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

more details
SearchViewModel
Number

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

more details
SearchViewModel
String

The placeholder used by the activeSource.

more details
SearchViewModel
Boolean

Indicates whether to display the Popup on feature click.

more details
SearchViewModel
PopupTemplate

A customized PopupTemplate for the selected feature.

more details
SearchViewModel
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
SearchViewModel
Graphic

The graphic used to highlight the resulting feature or location.

more details
SearchViewModel
Boolean

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

more details
SearchViewModel
Object[]

An array of current results from the search.

more details
SearchViewModel
Boolean

Indicates whether to display the option to search all sources.

more details
SearchViewModel
String

The value of the search box input text string.

more details
SearchViewModel
Object

The result selected from a search.

more details
SearchViewModel
Geometry|SuggestResult

The selected SuggestResult.

more details
SearchViewModel
Collection<(LayerSearchSource|LocatorSearchSource)>

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

more details
SearchViewModel
String

The current state of the widget.

more details
SearchViewModel
Number

The millisecond delay after keyup and before making a suggest network request.

more details
SearchViewModel
SuggestResult[]

An array of results from the suggest method.

more details
SearchViewModel
Boolean

Enable suggestions for the widget.

more details
SearchViewModel
Boolean

Indicates whether the View or Portal is loading resources prior to use.

more details
SearchViewModel
MapView|SceneView

A reference to the MapView or SceneView.

more details
SearchViewModel

Property Details

activeSource LayerSearchSource|LocatorSearchSourcereadonly

The source object currently selected. Can be either a feature layer or a locator.

activeSourceIndex Number

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

Default Value:0
allPlaceholder String

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"
Since: ArcGIS Maps SDK for JavaScript 4.8

The combined collection of defaultSources and sources. The defaultSources displays first in the Search UI.

autoSelect Boolean

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
declaredClass Stringreadonly inherited
Since: ArcGIS Maps SDK for JavaScript 4.7

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

Since: ArcGIS Maps SDK for JavaScript 4.8

A read-only property that is a Collection of LayerSearchSource and/or LocatorSearchSource. This property may contain ArcGIS Portal locators and any web map or web scene configurable search sources. Web maps or web scenes may contain map/feature service feature layer(s), and/or table(s) as sources.

This property is used to populate the Search UI if the sources property is not set.

defaultSymbols Object
Since: ArcGIS Maps SDK for JavaScript 4.22

The default symbol(s) for the search result. Choosing a symbol depends on the View type (SceneView or MapView), and the geometry type of the search result. This property allows developers to overwrite the default symbology for one or more geometry types.

Properties
optional

A SimpleMarkerSymbol, PointSymbol3D, TextSymbol, CIMSymbol, or WebStyleSymbol used for representing the point geometry that is being drawn for the search result. SimpleMarkerSymbol may also be used to symbolize point features in a SceneView. However, it is recommended you use PointSymbol3D instead.

optional

A SimpleFillSymbol, PolygonSymbol3D, or CIMSymbol used for representing the polygon geometry that is being drawn for the search result. SimpleFillSymbol may also be used to symbolize polygon features in a SceneView. However, it is recommended you use PolygonSymbol3D instead.

optional

A SimpleLineSymbol, LineSymbol3D, or CIMSymbol used for representing the polyline geometry that is being drawn for the search result. SimpleLineSymbol may also be used to symbolize polyline features in a SceneView. However, it is recommended you use LineSymbol3D instead.

Example
const searchWidget = new Search();

searchWidget.viewModel.defaultSymbols = {
   point: new PictureMarkerSymbol({
      url: "https://freesvg.org/img/1287178070.png",
      size: 24,
      width: 24,
      height: 24
   }),
   polygon: new SimpleFillSymbol({
      color: [235, 235, 235, 0.4],
      outline: {
         color: [130, 130, 130, 1],
         width: 2
      }
   }),
   polyline: new SimpleLineSymbol({
      color: [130, 130, 130, 1],
      width: 2
   })
};
goToOverride GoToOverride
Since: ArcGIS Maps SDK 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);
};
includeDefaultSources Boolean|Function
Since: ArcGIS Maps SDK 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
Example
// includeDefaultSources passed as a boolean value
let searchWidget = new Search({
  view: view
});
searchWidget.viewModel.includeDefaultSources = false;

// includeDefaultSources passed as a function
let searchWidget = new Search({
  view: view
});
searchWidget.viewModel.includeDefaultSources = function(sourcesResponse) {
    return sourcesResponse.defaultSources;
};
locationEnabled Boolean
Since: ArcGIS Maps SDK for JavaScript 4.8

Indicates whether location services are enabled 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).

maxInputLength Number

The maximum character length of the search text.

Default Value:128
maxResults Number

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

Default Value:6
maxSuggestions Number

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
minSuggestCharacters Number

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

Default Value:1
placeholder Stringreadonly

The placeholder used by the activeSource.

popupEnabled Boolean

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

Default Value:true
popupTemplate PopupTemplate

A customized PopupTemplate for the selected feature. Note that any templates defined on allSources take precedence over those defined directly on the template.

Default Value:null
portal Portal
Since: ArcGIS Maps SDK 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.

resultGraphic Graphicreadonly

The graphic used to highlight the resulting feature or location.

Default Value:null
resultGraphicEnabled Boolean

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

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

Default Value:true
results Object[]readonly

An array of current results from the search.

Default Value:null
searchAllEnabled Boolean

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-true-false

Default Value:true
searchTerm String

The value of the search box input text string.

selectedResult Objectreadonly

The result selected from a search.

Default Value:null
selectedSuggestion Geometry|SuggestResultreadonly

The selected SuggestResult.

Default Value:null

The Search widget may be used to search features in a FeatureLayer or table, 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
[
  {
    url: "https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer",
    singleLineFieldName: "SingleLine",
    outFields: ["Addr_type"],
    name: "ArcGIS World Geocoding Service",
    placeholder: "Adresse",
    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[]
let sources = [
{
  url: "https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer",
  singleLineFieldName: "SingleLine",
  name: "Custom Geocoding Service",
  placeholder: "Search Geocoder",
  maxResults: 3,
  maxSuggestions: 6,
  suggestionsEnabled: false,
  minSuggestCharacters: 0
}, {
  layer: 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
},
{
  layer: 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
let searchWidget = new Search({
  viewModel: { // autocasts as new SearchViewModel()
    sources: []
  }
});

// Set source(s)
let searchWidget = new Search();
let sources = [{ ... }, { ... }, { ... }]; //array of sources
searchWidget.viewModel.sources = sources;

// Add to source(s)
let searchWidget = new Search();
searchWidget.viewModel.sources.push({ ... });  //new source
state Stringreadonly
Since: ArcGIS Maps SDK for JavaScript 4.8

The current state of the widget. This property was removed from Search and should now be accessed within the SearchViewModel.

Possible Values:"ready"|"disabled"|"searching"|"loading"

Default Value:ready
suggestionDelay Number

The millisecond delay after keyup and before making a suggest network request.

Default Value:350
suggestions SuggestResult[]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.

Default Value:null
suggestionsEnabled Boolean

Enable suggestions for the widget.

This is only available if working with a 10.3 or greater geocoding service that has [suggest capability loaded] (https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. supportsPagination = true.

Default Value:true
updating Booleanreadonly
Since: ArcGIS Maps SDK for JavaScript 4.16

Indicates whether the View or Portal is loading resources prior to use. If resources are still loading, this value is false. If resources are done loading, this value is true.

Default Value:false

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

Default Value:null

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor

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

more details
SearchViewModel
Boolean

Emits an event on the instance.

more details
SearchViewModel
Boolean

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

more details
SearchViewModel
Boolean

Returns true if a named group of handles exist.

more details
Accessor
Object

Registers an event handler on the instance.

more details
SearchViewModel

Removes a group of handles owned by the object.

more details
Accessor
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 the applicable results.

more details
SearchViewModel
Promise<SearchResponse>

Returns search results near your current location.

more details
SearchViewModel
Promise<SuggestResponse>

Performs a suggest() request on the active Locator.

more details
SearchViewModel
Promise

when() may be leveraged once the SearchViewModel has been updated.

more details
when

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

clear()

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

emit(type, event){Boolean}
Since: ArcGIS Maps SDK 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
optional

The event payload.

Returns
Type Description
Boolean true if a listener was notified
hasEventListener(type){Boolean}

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
Type Description
Boolean Returns true if the class supports the input event.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
on(type, listener){Object}

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

Parameters

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns
Type Description
Object Returns an event handler with a remove() method that should be called to stop listening for the event(s).
Property Type Description
remove Function When called, removes the listener from the event.
Example
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});
removeHandles(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

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

Parameter
optional

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

Returns
Type Description
Promise<SearchResponse> When resolved, returns an object containing an array of search results.
searchNearby(){Promise<SearchResponse>}

Returns search results near your current location. It checks whether locationEnabled is true. If so, and your browser supports geolocation, it will return search results nearby your current location.

Returns
Type Description
Promise<SearchResponse> When resolved, returns SearchResponse containing an array of search objects. Each of these objects contains a SearchResult.
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
Type Description
Promise<SuggestResponse> When resolved, returns SuggestResponse containing an array of result objects. Each of these results contains a SuggestResult.
when(callback, errback){Promise}inner
Since: ArcGIS Maps SDK for JavaScript 4.16

when() may be leveraged once the SearchViewModel has been updated. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

Returns
Type Description
Promise Returns a new promise for the result of callback.
Example
// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

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
results SearchResult[]

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 the 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
results SuggestResult[]

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

Name Type Summary Class

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

more details
SearchViewModel
{activeSourceIndex: Number,errors: Error[],numResults: Number,searchTerm: String,results: Object[],results.results: SearchResult[],results.sourceIndex: Number,results.source: Object[]}

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

more details
SearchViewModel

Fires when the search() method starts.

more details
SearchViewModel
{result: Object,result.extent: Extent,result.feature: Graphic,result.name: String,source: Object,sourceIndex: Number}

Fires when a search result is selected.

more details
SearchViewModel
{activeSourceIndex: Number,errors: Error[],numResults: Number,searchTerm: String,results: Object[],results.results: SuggestResult[],results.sourceIndex: Number,results.source: Object}

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

more details
SearchViewModel

Fires when the suggest() method starts.

more details
SearchViewModel

Event Details

search-clear

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

Example
let searchWidget = new Search();

searchWidget.viewModel.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
results SearchResult[]

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
let searchWidget = new Search();

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

Fires when the search() method starts.

Example
let searchWidget = new Search();

searchWidget.viewModel.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
let searchWidget = new Search();

searchWidget.viewModel.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 about the result object.

Specification
results SuggestResult[]

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
let searchWidget = new Search();

searchWidget.viewModel.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
let searchWidget = new Search();

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

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.