PopupMedia Class

GeoElement."> PopupMedia Class | ArcGISQtCpp
  • PopupMedia
  • class Esri::ArcGISRuntime::PopupMedia

    The media that is displayed in a Popup for a GeoElement. More...

    Header: #include <PopupMedia.h>
    Since: Esri::ArcGISRuntime 100.0
    Inherits: Esri::ArcGISRuntime::Object

    Public Functions

    PopupMedia(QObject *parent = nullptr)
    virtual ~PopupMedia() override
    QString caption() const
    QFuture<Esri::ArcGISRuntime::ChartImage *> generateChartAsync(Esri::ArcGISRuntime::ChartImageParameters *parameters, QObject *parent = nullptr)
    quint64 imageRefreshInterval() const
    Esri::ArcGISRuntime::PopupMediaType popupMediaType() const
    void setCaption(const QString &caption)
    void setImageRefreshInterval(quint64 imageRefreshInterval)
    void setPopupMediaType(Esri::ArcGISRuntime::PopupMediaType popupMediaType)
    void setTitle(const QString &title)
    void setValue(Esri::ArcGISRuntime::PopupMediaValue *popupMediaValue)
    QString title() const
    Esri::ArcGISRuntime::PopupMediaValue *value() const

    Detailed Description

    Member Function Documentation

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

    Default constructor that takes an optional parent.

    [override virtual] PopupMedia::~PopupMedia()

    Destructor.

    QString PopupMedia::caption() const

    Returns the caption that is displayed for the media.

    See also setCaption().

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

    Returns generates a ChartImage with an image of the chart.

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

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

    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 pop-up 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::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.

    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().

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.