• MediaPopupElement
  • class Esri::ArcGISRuntime::MediaPopupElement

    A pop-up element that displays the media (images and charts) of a GeoElement in a pop-up. More...

    Header: #include <MediaPopupElement>
    Since: Esri::ArcGISRuntime 100.14
    Inherits: Esri::ArcGISRuntime::PopupElement

    Public Functions

    MediaPopupElement(const QList<Esri::ArcGISRuntime::PopupMedia *> &media, QObject *parent = nullptr)
    virtual ~MediaPopupElement() override
    QString description() const
    Esri::ArcGISRuntime::PopupMediaListModel *media() const
    void setDescription(const QString &description)
    void setTitle(const QString &title)
    QString title() const

    Detailed Description

    The order in which images or charts are displayed in the pop-up is determined by the order of the PopupMedia objects in the media PopupMediaListModel. If you want to display a chart, you must create an image of the chart by calling PopupMedia::generateChartAsync(Esri::ArcGISRuntime::ChartImageParameters*, QObject*). Use the ChartImageParameters to specify the height and width of the ChartImage and whether it includes a legend.

    Note that videos are only supported as attachments and can be viewed with AttachmentsPopupElement.

    See also PopupElementType.

    Member Function Documentation

    [explicit] MediaPopupElement::MediaPopupElement(const QList<Esri::ArcGISRuntime::PopupMedia *> &media, QObject *parent = nullptr)

    Creates a new media pop-up element with the given QList of PopupMedia.

    • media - An QList of PopupMedia objects that define images and charts displayed in the pop-up window.
    • parent - The optional parent QObject.

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

    Destructor.

    QString MediaPopupElement::description() const

    Returns a string value describing the element in detail. The value can be an empty string.

    See also setDescription().

    Esri::ArcGISRuntime::PopupMediaListModel *MediaPopupElement::media() const

    Returns a QList of PopupMedia objects that define images and charts displayed in the pop-up window.

    void MediaPopupElement::setDescription(const QString &description)

    Sets the description to description.

    See also description.

    void MediaPopupElement::setTitle(const QString &title)

    Sets the title to title.

    See also title.

    QString MediaPopupElement::title() const

    Returns a string value indicating what the element represents. The value can be an empty string.

    See also setTitle().