Skip To Content ArcGIS for Developers Sign In Dashboard

SuggestParameters QML Type

Parameters for suggesting potential matches using a LocatorTask. More...

Import Statement: import Esri.ArcGISRuntime 100.6
Since: Esri.ArcGISRuntime 100.0
Inherits:

Object

Properties

Signals

Detailed Description

Suggestions are used to create an auto-complete experience, where as a user types an address, potential matches are returned and displayed to the user. Use SuggestParameters to set the maximum results to be returned from a suggestion, or to specify a bounding geometry to search within. SuggestParameters are not required to use suggestions with the LocatorTask, but they allow for more fine-grain preferences to be applied to the task.

Apply the SuggestParameters to your search with SuggestListModel::suggestParameters.

This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.

Property Documentation

categories : list<string>

The list of categories used for suggestions.

The category parameter limits the types of places for which the service searches, thus eliminating false positive matches and potentially speeding up the search process. You can specify categories by different levels of detail. For example, if you were searching for somewhere to eat, you could specify the category as "Korean Food" for something specific, "Food" for something more generic, or even "POI" for something very generic.

Note: Categories are currently not supported with local locators. However, a gazateer-style locator could be used instead to get a similar output.

See also Category filtering.


countryCode : string

The country code used for suggestions.

Examples of country codes include CN for China, IS for Iceland, and US for The United States.

See also Geocoding Country Codes.


maxResults : int

The maximum results to be returned by a suggestion.


[default] preferredSearchLocation : Point

The preferred search location of a suggestion.

The search operation can sort result items by their proximity to a preferred search location, such as the user's current location. The priority of the items within 50,000 meters of this location are boosted relative to items that are farther away.

For example, when searching by name for a business with many locations in the area, there will be many matched items even when a search area is specified. The user would have to look through the items to find the closest store. When the preferred search location is set to the user's current location, the locator can prioritize the items based on proximity to the user.

By default, no preferred search location is set.


[default] searchArea : Geometry

The search area of a suggestion.

For example, you may want to only search for addresses that are inside of the map view's currently visible extent.


Signal Documentation

categoriesChanged()

Emitted when the categories property of this SuggestParameters changes.


countryCodeChanged()

Emitted when the countryCode property of this SuggestParameters changes.


maxResultsChanged()

Emitted when the maxResults property of this SuggestParameters changes.


preferredSearchLocationChanged()

Emitted when the preferredSearchLocation property of this SuggestParameters changes.


searchAreaChanged()

Emitted when the searchArea property of this SuggestParameters changes.



Feedback on this topic?