PopupMediaValue Class

Member Function Documentation

[explicit] PopupMediaValue::PopupMediaValue(QObject *parent = nullptr)

Default constructor that takes an optional parent.

[override virtual] PopupMediaValue::~PopupMediaValue()

Destructor.

[since Esri::ArcGISRuntime 200.3] QVariantList PopupMediaValue::data() const

Returns the attribute values for the pop-up media's fields defined in fieldNames. This property is populated when Popup::evaluateExpressionsAsync is called.

For PopupMediaValue objects used with an image or if PopupElement::isEvaluated is false, this will be an empty collection. The data will be normalized if normalizeFieldName is not empty.

This function was introduced in Esri::ArcGISRuntime 200.3.

QStringList PopupMediaValue::fieldNames() const

Returns the GeoElement's fields (attributes) whose values should be displayed in the chart.

Only applicable if media is a chart.

See also setFieldNames().

[since Esri::ArcGISRuntime 200.3] QStringList PopupMediaValue::labels() const

Returns the user-friendly display names for the pop-up media's fields defined in fieldNames. This property is populated when Popup::evaluateExpressionsAsync is called.

For PopupMediaValue objects used with an image or if PopupElement::isEvaluated is false, this will be an empty collection.

This function was introduced in Esri::ArcGISRuntime 200.3.

QUrl PopupMediaValue::linkUrl() const

Returns the URL that defines which web address the image links to.

Only applicable is media is an image.

See also setLinkUrl().

QString PopupMediaValue::normalizeFieldName() const

Returns the GeoElement's field (attribute) whose value should be used to normalize values of fields.

Only applicable if media is a chart.

See also setNormalizeFieldName().

void PopupMediaValue::setFieldNames(const QStringList &fieldNames)

Sets the GeoElement's fieldNames (attributes) whose values should be displayed in the chart.

Only applicable if media is a chart.

See also fieldNames().

void PopupMediaValue::setLinkUrl(const QUrl &linkUrl)

Sets the linkUrl that defines which web address the image links to.

Only applicable is media is an image.

See also linkUrl().

void PopupMediaValue::setNormalizeFieldName(const QString &normalizeFieldName)

Sets the GeoElement's normalizeFieldName whose value should be used to normalize values of fields.

For example, if one field is Total Population, and another is Area, you may want to normalize Total Population by Area to see the population density.

Only applicable if media is a chart.

See also normalizeFieldName().

void PopupMediaValue::setSourceUrl(const QUrl &sourceUrl)

Sets the image's source URL to sourceUrl.

Only applicable is media is an image.

See also sourceUrl().

void PopupMediaValue::setTooltipFieldName(const QString &tooltipFieldName)

Sets the GeoElement's tooltipFieldName whose value should be used to display a tooltip for sections of the chart.

Only applicable if media is a chart.

See also tooltipFieldName().

QUrl PopupMediaValue::sourceUrl() const

Returns the image's source URL.

Only applicable if media is an image.

See also setSourceUrl().

QString PopupMediaValue::tooltipFieldName() const

Returns the GeoElement's field (attribute) whose value should be used to display a tooltip for sections of the chart.

Only applicable if media is a chart.

See also setTooltipFieldName().