• KmlIcon
  • class Esri::ArcGISRuntime::KmlIcon

    A KML Icon Object. More...

    Header: #include <KmlIcon.h>
    Since: Esri::ArcGISRuntime 100.6
    Inherits: Esri::ArcGISRuntime::Object

    Public Functions

    KmlIcon(const QUrl &url, QObject *parent = nullptr)
    quint64 refreshInterval() const
    Esri::ArcGISRuntime::KmlRefreshMode refreshMode() const
    void setRefreshInterval(quint64 refreshInterval)
    void setRefreshMode(Esri::ArcGISRuntime::KmlRefreshMode refreshMode)
    void setViewRefreshMode(Esri::ArcGISRuntime::KmlViewRefreshMode viewRefreshMode)
    void setViewRefreshTime(quint64 viewRefreshTime)
    QUrl url() const
    Esri::ArcGISRuntime::KmlViewRefreshMode viewRefreshMode() const
    quint64 viewRefreshTime() const

    Detailed Description

    A KML icon specifies the location and refresh paramaters of an overlay image.

    Relevant samples:

    Member Function Documentation

    [explicit] KmlIcon::KmlIcon(const QUrl &url, QObject *parent = nullptr)

    Creates a KML icon from the provided image file url and optional parent.

    quint64 KmlIcon::refreshInterval() const

    Returns the icon's refresh interval in milliseconds

    See also setRefreshInterval().

    Esri::ArcGISRuntime::KmlRefreshMode KmlIcon::refreshMode() const

    Returns the icon's refresh mode.

    See also setRefreshMode().

    void KmlIcon::setRefreshInterval(quint64 refreshInterval)

    Sets the icon's refreshInterval in milliseconds

    See also refreshInterval().

    void KmlIcon::setRefreshMode(Esri::ArcGISRuntime::KmlRefreshMode refreshMode)

    Sets the icon's refreshMode. Defaults to KmlRefreshMode::OnChange

    See also refreshMode().

    void KmlIcon::setViewRefreshMode(Esri::ArcGISRuntime::KmlViewRefreshMode viewRefreshMode)

    Sets the icon's viewRefreshMode. Defaults to KmlViewRefreshMode::Never

    See also viewRefreshMode().

    void KmlIcon::setViewRefreshTime(quint64 viewRefreshTime)

    Sets the icon's viewRefreshTime in milliseconds

    See also viewRefreshTime().

    QUrl KmlIcon::url() const

    Returns the icon's image file url

    Esri::ArcGISRuntime::KmlViewRefreshMode KmlIcon::viewRefreshMode() const

    Returns the icon's view refresh mode.

    See also setViewRefreshMode().

    quint64 KmlIcon::viewRefreshTime() const

    Returns the icon's view refresh time in milliseconds

    See also setViewRefreshTime().