The source object currently selected.
The selected source's index.
String value used as a hint for input text when searching on multiple sources.
The combined collection of defaultSources and sources.
Indicates whether to automatically select and zoom to the first geocoded result.
The ID or node representing the DOM element containing the widget.
A read-only property that is a Collection of LayerSearchSource and/or LocatorSearchSource.
When true, the widget is visually withdrawn and cannot be interacted with.
This function provides the ability to override either the IMapView goTo() or SceneView goTo() methods.
The widget's default CSS icon class.
The unique ID assigned to the widget when the widget is created.
Indicates whether or not to include defaultSources in the Search UI.
The widget's label.
Enables location services within the widget.
The maximum number of results returned by the widget if not specified by the source.
The maximum number of suggestions returned by the widget if not specified by the source.
The minimum number of characters needed for the search if not specified by the source.
Indicates whether to display the Popup on feature click.
A customized PopupTemplate for the selected feature.
It is possible to search a specified portal instance's locator services Use this property to set this ArcGIS Portal instance to search.
The graphic used to highlight the resulting feature or location.
Indicates if the resultGraphic will display at the location of the selected feature.
An array of objects, each containing a SearchResult from the search.
Indicates whether to display the option to search all sources.
The value of the search box input text string.
The result selected from a search.
The Search widget may be used to search features in a map/feature service feature layer(s), SceneLayers with an associated feature layer, BuildingComponentSublayer with an associated feature layer, GeoJSONLayer, CSVLayer or OGCFeatureLayer, or table, or geocode locations with a Locator.
An array of results from the suggest method.
Enable suggestions for the widget.
The view model for this widget.
Indicates whether the widget is visible.
Unfocuses the widget's text input.
A utility method used for building the value for a widget's class property.
Clears the current searchTerm, search results, suggest results, graphic, and graphics layer.
Destroys the widget instance.
Emits an event on the instance.
Brings focus to the widget's text input.
Indicates whether there is an event listener on the instance that matches the provided event name.
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).
isRejected() may be used to verify if creating an instance of the class is rejected.
isResolved() may be used to verify if creating an instance of the class is resolved.
Widget teardown helper.
This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.
This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.
Renders widget to the DOM immediately.
This method is primarily used by developers when implementing custom widgets. Schedules widget rendering.
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.
Performs a suggest() request on the active Locator.
when() may be leveraged once an instance of the class is created.
Generated using TypeDoc
The current active menu of the Search widget.
Read more...