UtilityAssociationsPopupElement Class

UtilityAssociationsPopupElement

class Esri::ArcGISRuntime::UtilityAssociationsPopupElement

A utility network associations pop-up element that is displayed in a pop-up for a geoelement. More...

Header:	`#include <UtilityAssociationsPopupElement.h>`
Since:	Esri::ArcGISRuntime 200.7
Inherits:	Esri::ArcGISRuntime::PopupElement

List of all members, including inherited members

Public Functions

	UtilityAssociationsPopupElement(const QList<Esri::ArcGISRuntime::UtilityAssociationsFilter > &associationFilters, QObject parent = nullptr)
virtual	~UtilityAssociationsPopupElement() override
QList<Esri::ArcGISRuntime::UtilityAssociationsFilter *>	associationFilters() const
QList<Esri::ArcGISRuntime::UtilityAssociationsFilterResult *>	associationsFilterResults() const
QString	description() const
int	displayCount() const
QFuture<void>	fetchAssociationsFilterResultsAsync()
void	setDescription(const QString &description)
void	setDisplayCount(int displayCount)
void	setTitle(const QString &title)
QString	title() const

Detailed Description

A typical UI implementation displays UtilityAssociation based on displayCount with a possibility to show all associations for a specific layer or table.

See also PopupElementType.

Member Function Documentation

`[explicit]` UtilityAssociationsPopupElement::UtilityAssociationsPopupElement(const QList<Esri::ArcGISRuntime::UtilityAssociationsFilter > &associationFilters*, QObject **parent* = nullptr)

Creates a new utility network association pop-up element which displays associations based on the filters provided.

associationFilters - A collection of utility associations filters that specify the displayed utility associations.
parent - The optional parent QObject.

If no filters are provided, all associations will be displayed.

`[override virtual noexcept]` UtilityAssociationsPopupElement::~UtilityAssociationsPopupElement()

Destructor.

QList<Esri::ArcGISRuntime::UtilityAssociationsFilter *> UtilityAssociationsPopupElement::associationFilters() const

Returns a collection of utility associations filters.

Filters limit the associations displayed based upon the associated element's role or function. If no filters are provided, all associations will be displayed.

QList<Esri::ArcGISRuntime::UtilityAssociationsFilterResult *> UtilityAssociationsPopupElement::associationsFilterResults() const

Returns a collection of utility associations filter results. This is empty if associations filter results haven't been fetched.

Associations are fetched using fetchAssociationsFilterResultsAsync.

QString UtilityAssociationsPopupElement::description() const

Returns string describing the pop-up element in detail.

See also setDescription().

int UtilityAssociationsPopupElement::displayCount() const

Returns the number of associations to display based on the UtilityAssociationsFilter provided.

The default value is 3.

See also setDisplayCount().

QFuture<void> UtilityAssociationsPopupElement::fetchAssociationsFilterResultsAsync()

Fetches all UtilityAssociation objects based on the associationFilters. It will populate associationsFilterResults.

If PopupElement::isEvaluated is false, this method will have no effect.

This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

void UtilityAssociationsPopupElement::setDescription(const QString &description)

Sets the description to description.

See also description.

void UtilityAssociationsPopupElement::setDisplayCount(int displayCount)

Sets the displayCount to displayCount.

See also displayCount.

void UtilityAssociationsPopupElement::setTitle(const QString &title)

Sets the title to title.

See also title.

QString UtilityAssociationsPopupElement::title() const

Returns string indicating what the pop-up element represents.

The default value is the feature's Association Status.