Uses a Locator to provide search and suggest results. More...
Since: | Esri.ArcGISRuntime 100.13 |
Inherited By: |
Properties
- displayName : string
- geocodeParameters : GeocodeParameters
- locatorTask : LocatorTask
- maximumResults : int
- maximumSuggestions : int
- preferredSearchLocation : Point
- suggestParameters : SuggestParameters
- suggestions : ListModel
Signals
- searchCompleted(list searchResults)
Methods
- void search(var query, Geometry area)
Detailed Description
Note: Most configuration should be done on the GeocodeParameters directly.
Property Documentation
The parameters used for geocoding. Some properties on parameters will be updated automatically based on searches.
The maximum suggestions to return when performing a search.
Note: Defaults to 6.
The parameters used for suggestions. Some properties on parameters will be updated automatically based on searches.
The collection of suggestion results.
A suggestion is a ListElement with the following fields.
name | type | description |
---|---|---|
displayTitle | string | The suggestion heading. |
displaySubtitle | string | Optional suggestion subheading. |
collection | bool | Flag for if the suggestion is a boolean. |
markerImageUrl | url | URL of the image to display alongside suggestion. |
owningSource | object | The search-source this suggestion was created from. |
suggestion | SuggestionResult | The SuggestionResult that populated this ListElement . |
Signal Documentation
Signal emitted when the search completes, giving the found search results as searchResults.
A result is a ListElement with the following fields.
name | type | description |
---|---|---|
displayTitle | string | The result heading. |
displaySubtitle | string | Optional result subheading. |
markerImageUrl | url | URL of the image to display alongside result. |
owningSource | object | The search-source this result was created from. |
geoElement | GeoElement | The optional map location/graphic of this result. |
selectionViewpoint | Envelope | An area containing the result. |
Note: The corresponding handler is onSearchCompleted
.
Method Documentation
Starts a search using query as input.
query can be a string
or a SuggestResult
.
If area is non-null, search is restricted to that area.