KmlNetworkLink Class

Member Function Documentation

[explicit, since Esri::ArcGISRuntime 100.6] 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 true if the app should zoom to the KmlNetworkLink when it refreshes, false otherwise.

When this is defined, the app should zoom to the viewpoint defined on the associated NetworkLinkControl or the network links' top-level KML node upon refresh of the link. The app will not automatically fly to the node on refresh. It is the application 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 true if the visibility selection is preserved for nodes in a network link after refresh, false otherwise.

This corresponds to the 'refreshVisibility' property in the source KML file.

See also setHasRefreshVisibility().

bool KmlNetworkLink::isOpen() const

Returns true if the KML network link is open, false otherwise.

bool KmlNetworkLink::isPartiallyVisible() const

Returns true if the KML network link is partially visible, false otherwise.

Esri::ArcGISRuntime::KmlListItemType KmlNetworkLink::listItemType() const

Returns the list item type of the KmlNetworkLink.

See also setListItemType().

[since Esri::ArcGISRuntime 100.7] void KmlNetworkLink::refresh()

Refreshes the KML network link.

This function was introduced in Esri::ArcGISRuntime 100.7.

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

[since Esri::ArcGISRuntime 100.7] Esri::ArcGISRuntime::KmlRefreshMode KmlNetworkLink::refreshMode() const

The KML network link refresh mode.

This function was introduced in Esri::ArcGISRuntime 100.7.

See also setRefreshMode().

[since Esri::ArcGISRuntime 100.6] 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.

[since Esri::ArcGISRuntime 100.6] 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().

[since Esri::ArcGISRuntime 100.6] 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().

[since Esri::ArcGISRuntime 100.7] 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().

[since Esri::ArcGISRuntime 100.7] 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().

[since Esri::ArcGISRuntime 100.6] 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().

[since Esri::ArcGISRuntime 200.6] void KmlNetworkLink::setViewBoundScale(double viewBoundScale)

Sets the viewBoundScale to viewBoundScale.

This function was introduced in Esri::ArcGISRuntime 200.6.

See also viewBoundScale.

[since Esri::ArcGISRuntime 100.7] 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().

[since Esri::ArcGISRuntime 100.7] 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.

[since Esri::ArcGISRuntime 200.6] double KmlNetworkLink::viewBoundScale() const

Returns the scale factor to apply to the bounding box parameters when retrieving the network link. Only applied if KmlViewRefreshMode is a value other than KmlViewRefreshMode::Never.

A value of 1.0 covers the visible extent. Values less than 1.0 specifies to use less than visible extent, while values greater than 1.0 specifies to use beyond visible extent. The default value is 1.0. Refer to the KML Link documentation for more details.

This function was introduced in Esri::ArcGISRuntime 200.6.

See also setViewBoundScale().

[since Esri::ArcGISRuntime 100.7] 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().

[since Esri::ArcGISRuntime 100.7] 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().