SearchResult Class

Member Function Documentation

[invokable] SearchResult::SearchResult(QObject *parent = nullptr)

Constructs a new SearchResult object with a given parent.

[override virtual] SearchResult::~SearchResult()

Destructor.

QString SearchResult::displaySubtitle() const

Returns the optional subtitle that should be shown whenever a result is displayed.

See also setDisplaySubtitle().

[signal] void SearchResult::displaySubtitleChanged()

Signal emitted when the displaySubtitle changes.

QString SearchResult::displayTitle() const

Returns the title that should be shown whenever a result is displayed.

See also setDisplayTitle().

[signal] void SearchResult::displayTitleChanged()

Signal emitted when the displayTitleChanged changes.

Esri::ArcGISRuntime::GeoElement *SearchResult::geoElement() const

Returns the geo-element.

For locator results, should be the graphic that was used to display the result on the map. For feature layer results, should be the result feature. Can be null depending on the type of the result, and can have GeoElements without a defined geometry.

See also setGeoElement().

[signal] void SearchResult::geoElementChanged()

Signal emitted when the geoElement changes.

QUrl SearchResult::markerImageUrl() const

Returns the marker that would be shown on the map. This property is available as a convenience such that consumers need not worry whether the Esri::ArcGISRuntime::GeoElement is a graphic or a feature when displaying the icon in the UI.

See also setMarkerImageUrl().

[signal] void SearchResult::markerImageUrlChanged()

Signal emitted when the markerImageUrlChanged changes.

Esri::ArcGISRuntime::Toolkit::SearchSourceInterface *SearchResult::owningSource()

Returns pointer to the search source that created this result.

See also setOwningSource().

[signal] void SearchResult::owningSourceChanged()

Signal emitted when the owningSource changes.

Esri::ArcGISRuntime::Viewpoint SearchResult::selectionViewpoint() const

Returns the viewpoint to be used when the view zooms to a selected result.

This property can be default-constructed because not all valid results will have a geometry. E.g. feature results from non-spatial features.

See also setSelectionViewpoint().

[signal] void SearchResult::selectionViewpointChanged()

Signal emitted when the selectionViewpoint changes.

void SearchResult::setDisplaySubtitle(QString displaySubtitle)

Sets the optional subtitle that should be shown whenever a result is displayed to displaySubtitle.

See also displaySubtitle().

void SearchResult::setDisplayTitle(QString displayTitle)

Sets the title that should be shown whenever a result is displayed to displayTitle.

See also displayTitle().

void SearchResult::setGeoElement(Esri::ArcGISRuntime::GeoElement *geoElement)

Sets the geo-element to geoElement.

See also geoElement().

void SearchResult::setMarkerImageUrl(QUrl markerImageUrl)

Sets the marker that would be shown on the map to the image located at markerImageUrl. This property is available as a convenience. Calling this setter after construction will not update the geoElement image automatically.

See also markerImageUrl().

void SearchResult::setOwningSource(Esri::ArcGISRuntime::Toolkit::SearchSourceInterface *owningSource)

Sets the pointer to the search source owningSource that created this result.

See also owningSource().

void SearchResult::setSelectionViewpoint(Esri::ArcGISRuntime::Viewpoint selectionViewpoint)

Sets the viewpoint to be used when the view zooms to a selected result to selectionViewpoint.

See also selectionViewpoint().