PopupMedia Class

Member Function Documentation

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

Default constructor that takes an optional parent.

[override virtual noexcept] PopupMedia::~PopupMedia()

Destructor.

QString PopupMedia::alternativeText() const

Returns the alternativeText for the media.

See also setAlternativeText().

QString PopupMedia::caption() const

Returns the caption that is displayed for the media.

This can contain placeholders, which are dynamic variables, that retrieve and display attribute data specific to the geoelement that the pop-up is displayed for.

Placeholders allow the pop-up content to update contextually based on the user's interaction with the map.

They are enclosed in curly braces and support two primary data sources:

• Standard fields: using attribute values (for example, `{CITY_NAME}`).
• Arcade expressions: displaying the results of custom logic or calculations (for example, {expression/expr0}).

See also setCaption().

[since Esri::ArcGISRuntime 200.3] QFuture<Esri::ArcGISRuntime::ChartImage *> PopupMedia::generateChartAsync(Esri::ArcGISRuntime::ChartImageParameters *parameters, QObject *parent = nullptr)

Generates a ChartImage with an image of the chart.

• parameters - The parameters used to generate the popup chart.
• parent - The optional parent QObject.

Will fail if the pop_up media is a PopupMediaType::Image or if PopupElement::isEvaluated is false.

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.

This function was introduced in Esri::ArcGISRuntime 200.3.

[since Esri::ArcGISRuntime 200.3] quint64 PopupMedia::imageRefreshInterval() const

Returns the image refresh interval. This property is useful only for a popup media of type PopupMediaType::Image.

The refresh interval, in milliseconds. A refresh interval of 0 means never refresh. The default value is 0.

This function was introduced in Esri::ArcGISRuntime 200.3.

See also setImageRefreshInterval().

Esri::ArcGISRuntime::PopupMediaType PopupMedia::popupMediaType() const

Returns the media's type.

See also setPopupMediaType().

void PopupMedia::setAlternativeText(const QString &alternativeText)

Sets the alternativeText for the media.

See also alternativeText().

void PopupMedia::setCaption(const QString &caption)

Sets the caption that is displayed for the media.

See also caption().

[since Esri::ArcGISRuntime 200.3] void PopupMedia::setImageRefreshInterval(quint64 imageRefreshInterval)

Sets the imageRefreshInterval to imageRefreshInterval.

This function was introduced in Esri::ArcGISRuntime 200.3.

See also imageRefreshInterval.

void PopupMedia::setPopupMediaType(Esri::ArcGISRuntime::PopupMediaType popupMediaType)

Sets the popupMediaType.

See also popupMediaType().

void PopupMedia::setTitle(const QString &title)

Sets the title that is displayed for the media.

See also title().

void PopupMedia::setValue(Esri::ArcGISRuntime::PopupMediaValue *popupMediaValue)

Sets the optional popupMediaValue.

Only applicable for chart or image media types.

See also value().

QString PopupMedia::title() const

Returns the title that is displayed for the media.

This can contain placeholders, which are dynamic variables, that retrieve and display attribute data specific to the geoelement that the pop-up is displayed for.

Placeholders allow the pop-up content to update contextually based on the user's interaction with the map.

They are enclosed in curly braces and support two primary data sources:

• Standard fields: using attribute values (for example, `{CITY_NAME}`).
• Arcade expressions: displaying the results of custom logic or calculations (for example, {expression/expr0}).

See also setTitle().

Esri::ArcGISRuntime::PopupMediaValue *PopupMedia::value() const

Returns the optional media info value.

Only applicable for chart or image media types.

See also setValue().