LocatorSearchSource QML Type

LocatorSearchSource

Uses a Locator to provide search and suggest results. More...

Since:	Esri.ArcGISRuntime 100.13
Inherited By:	SmartLocatorSearchSource

Properties

Note: Most configuration should be done on the GeocodeParameters directly.

displayName : string

The name to show when presenting this source in the UI.

[read-only] geocodeParameters : GeocodeParameters

The parameters used for geocoding. Some properties on parameters will be updated automatically based on searches.

locatorTask : LocatorTask

The locator used by this search source.

maximumResults : int

The maximum results to return when performing a search.

Note: Defaults to 6.

maximumSuggestions : int

The maximum suggestions to return when performing a search.

Note: Defaults to 6.

preferredSearchLocation : Point

The point to be used as an input to searches and suggestions.

[read-only] suggestParameters : SuggestParameters

The parameters used for suggestions. Some properties on parameters will be updated automatically based on searches.

[read-only] suggestions : ListModel

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

searchCompleted(list searchResults)

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.

void search(var query, Geometry area)

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.