SuggestResult QML Type
The result class returned from a suggest operation of a LocatorTask. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: |
Properties
- isCollection : bool
- label : string
Detailed Description
Note: You cannot declare or create a component of this type in QML code.
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. The potential matches that are returned are the SuggestResults. Suggestions can be made for street addresses, points of interest by name, points of interest by type (such as "restaurant"), administrative place names (such as "Seattle"), or postal codes.
Obtain the results from the SuggestListModel::get or SuggestListModel::forEach methods. The SuggestListModel is obtained through LocatorTask::suggestions.
Property Documentation
isCollection : bool |
Returns whether the candidate is related to a category or group (read-only).
Returns true if the candidate is related to a category or group and false otherwise. Candidate can be related with a category or group for example 'coffee', or some business name for example 'Starbucks'.
label : string |
Returns the label of the SuggestResult (read-only).
A common workflow is to use this label in the delegate of a list view to indicate potential address matches to the user.