A reference to a KML file or KMZ archive on a local or remote network. More...
Header: | #include <KmlNetworkLink.h> |
Since: | Esri::ArcGISRuntime 100.4 |
Inherits: | Esri::ArcGISRuntime::KmlNode |
This class was introduced in Esri::ArcGISRuntime 100.4.
Public Functions
KmlNetworkLink(const QUrl &url, QObject *parent = nullptr) | |
virtual | ~KmlNetworkLink() override |
bool | canFlyToNode() const |
QList<Esri::ArcGISRuntime::KmlNode *> | childNodes() const |
bool | hasRefreshVisibility() const |
bool | isOpen() const |
bool | isPartiallyVisible() const |
Esri::ArcGISRuntime::KmlListItemType | listItemType() const |
void | refresh() |
quint64 | refreshInterval() const |
Esri::ArcGISRuntime::KmlRefreshMode | refreshMode() const |
void | setCanFlyToNode(bool canFlyToNode) |
void | setHasRefreshVisibility(bool hasRefreshVisibility) |
void | setListItemType(Esri::ArcGISRuntime::KmlListItemType listItemType) |
void | setOpen(bool open) |
void | setRefreshInterval(quint64 refreshInterval) |
void | setRefreshMode(Esri::ArcGISRuntime::KmlRefreshMode refreshMode) |
void | setUrl(const QUrl &url) |
void | setViewRefreshMode(Esri::ArcGISRuntime::KmlViewRefreshMode viewRefreshMode) |
void | setViewRefreshTime(quint64 viewRefreshTime) |
QUrl | url() const |
Esri::ArcGISRuntime::KmlViewRefreshMode | viewRefreshMode() const |
quint64 | viewRefreshTime() const |
Detailed Description
Member Function Documentation
KmlNetworkLink::KmlNetworkLink (const QUrl &url, QObject *parent = nullptr)
Creates a KmlNetworkLink from the provided url to a KML/KMZ file, with an optional parent object.
This function was introduced in Esri::ArcGISRuntime 100.6.
[override virtual]
KmlNetworkLink::~KmlNetworkLink ()
Destructor.
bool KmlNetworkLink::canFlyToNode () const
Returns whether the app should zoom to the KmlNetworkLink when it refreshes.
When this is true
, the app should zoom to the viewpoint defined on the associated KmlNetworkLink or the link's top-level KML node upon refresh of the link.
Note: It is the developer's responsibility to implement this behavior if desired.
See also setCanFlyToNode().
QList<Esri::ArcGISRuntime::KmlNode *> KmlNetworkLink::childNodes () const
Returns the child nodes of the KmlNetworkLink.
bool KmlNetworkLink::hasRefreshVisibility () const
Returns whether the KmlNetworkLink has refresh visiblity after load.
See also setHasRefreshVisibility().
bool KmlNetworkLink::isOpen () const
Returns whether if the KmlNetworkLink is open.
bool KmlNetworkLink::isPartiallyVisible () const
Returns whether the KmlNetworkLink is partially visible.
Esri::ArcGISRuntime::KmlListItemType KmlNetworkLink::listItemType () const
Returns the list item type of the KmlNetworkLink.
See also setListItemType().
void KmlNetworkLink::refresh()
Refreshes the KML network link.
This function was introduced in Esri::ArcGISRuntime 100.7.
quint64 KmlNetworkLink::refreshInterval () const
The KML network link refresh interval, in milliseconds.
This function was introduced in Esri::ArcGISRuntime 100.7.
See also setRefreshInterval().
Esri::ArcGISRuntime::KmlRefreshMode KmlNetworkLink::refreshMode () const
The KML network link refresh mode.
This function was introduced in Esri::ArcGISRuntime 100.7.
See also setRefreshMode().
void KmlNetworkLink::setCanFlyToNode (bool canFlyToNode )
Sets whether the app should zoom to the KmlNetworkLink when it refreshes to canFlyToNode.
This function was introduced in Esri::ArcGISRuntime 100.6.
See also canFlyToNode.
void KmlNetworkLink::setHasRefreshVisibility (bool hasRefreshVisibility )
Sets whether the KML network link has refresh visiblity after load to hasRefreshVisibility.
This function was introduced in Esri::ArcGISRuntime 100.6.
See also hasRefreshVisibility().
void KmlNetworkLink::setListItemType (Esri::ArcGISRuntime::KmlListItemType listItemType )
Sets the list item type of the KmlNetworkLink to listItemType.
This function was introduced in Esri::ArcGISRuntime 100.6.
See also listItemType().
void KmlNetworkLink::setOpen (bool open)
Sets isOpen of the KmlNetworkLink to open.
See also isOpen().
void KmlNetworkLink::setRefreshInterval (quint64 refreshInterval )
Sets the KML network link refresh interval, in milliseconds to refreshInterval.
This function was introduced in Esri::ArcGISRuntime 100.7.
See also refreshInterval().
void KmlNetworkLink::setRefreshMode (Esri::ArcGISRuntime::KmlRefreshMode refreshMode )
Sets the KML network link refresh mode to refreshMode.
This function was introduced in Esri::ArcGISRuntime 100.7.
See also refreshMode().
void KmlNetworkLink::setUrl (const QUrl &url)
Sets the data path of the KmlNetworkLink to url.
After setting a new URL, call refresh to fetch the data from the new URL. If the refresh mode of the network link is KmlRefreshMode::OnInterval when the URL is changed, the refresh operation executed on the following interval will use the new URL.
This function was introduced in Esri::ArcGISRuntime 100.6.
See also url().
void KmlNetworkLink::setViewRefreshMode (Esri::ArcGISRuntime::KmlViewRefreshMode viewRefreshMode )
Sets the KML network link view refresh mode to viewRefreshMode.
This function was introduced in Esri::ArcGISRuntime 100.7.
See also viewRefreshMode().
void KmlNetworkLink::setViewRefreshTime (quint64 viewRefreshTime )
sets the KML network link view refresh time, in milliseconds to viewRefreshTime.
This function was introduced in Esri::ArcGISRuntime 100.7.
See also viewRefreshTime().
QUrl KmlNetworkLink::url() const
Returns the data path of the KmlNetworkLink.
See also setUrl.
Esri::ArcGISRuntime::KmlViewRefreshMode KmlNetworkLink::viewRefreshMode () const
The KML network link view refresh mode.
This function was introduced in Esri::ArcGISRuntime 100.7.
See also setViewRefreshMode().
quint64 KmlNetworkLink::viewRefreshTime () const
The KML network link view refresh time, in milliseconds.
This function was introduced in Esri::ArcGISRuntime 100.7.
See also setViewRefreshTime().