Skip To Content ArcGIS for Developers Sign In Dashboard

KmlNetworkLink QML Type

A reference to a KML file or KMZ archive on a local or remote network. More...

Import Statement: import Esri.ArcGISRuntime 100.7
Since: Esri.ArcGISRuntime 100.4
Inherits:

KmlNode

Properties

Signals

Methods

Detailed Description

Property Documentation

canFlyToNode : bool

A flag, indicating if the app should zoom to the KML network link when it refreshes.

When this is true, 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.

This property is writable as of Esri.ArcGISRuntime 100.6

Note: It is the developer's responsibility to implement this behavior if desired.


childNodes : list<KmlNode>

Returns the KML network link's child nodes.


hasRefreshVisibility : bool

A flag, indicating if the KML network link has refresh visiblity after load.

This property is writable as of Esri.ArcGISRuntime 100.6


listItemType : Enums.KmlListItemType

A flag, indicating the network link's list item type.

This property is writable as of Esri.ArcGISRuntime 100.6

See also Enums.KmlListItemType.


open : bool

Returns a flag indicating if the KML network link is open.


partiallyVisible : bool

Returns a flag indicating if the KML network link is partially visible (read-only).


refreshInterval : string

The KML network link refresh interval, in milliseconds.

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

This QML property was introduced in Esri.ArcGISRuntime 100.7.

See also refreshIntervalAsInt.


refreshIntervalAsInt : int

The KML network link refresh interval, in milliseconds, but represented as an integer type.

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

This QML property was introduced in Esri.ArcGISRuntime 100.7.


refreshMode : Enums.KmlRefreshMode

The KML network link refresh mode.

This property is writable as of Esri.ArcGISRuntime 100.7

See also Enums.KmlRefreshMode.


url : url

URL, indicating the KML network link's data path.

This property is writable as of Esri.ArcGISRuntime 100.6

After setting a new URL, call refresh to fetch the data from the new URL. If the refresh mode of the network link is Enums.KmlRefreshModeOnInterval when the URL is changed, the refresh operation executed on the following interval will use the new URL.


viewRefreshMode : Enums.KmlViewRefreshMode

The KML network link view refresh mode.

This property is writable as of Esri.ArcGISRuntime 100.7

See also Enums.KmlViewRefreshMode.


viewRefreshTime : string

The KML network link view refresh time, in milliseconds.

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

This QML property was introduced in Esri.ArcGISRuntime 100.7.

See also viewRefreshTimeAsInt.


viewRefreshTimeAsInt : int

The KML network link view refresh time, in milliseconds, but represented as an integer type.

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

This QML property was introduced in Esri.ArcGISRuntime 100.7.


Signal Documentation

canFlyToNodeChanged()

Emitted when the canFlyToNode property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.6.


childNodesChanged()

Emitted when the childNodes property changes.


hasRefreshVisibilityChanged()

Emitted when the hasRefreshVisibility property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.6.


listItemTypeChanged()

Emitted when the listItemTypeChanged property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.6.


openChanged()

Emitted when the open property changes.


partiallyVisibleChanged()

Emitted when the partiallyVisible property changes.


refreshIntervalChanged()

Emitted when the refreshInterval property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.7.


refreshModeChanged()

Emitted when the refreshMode property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.7.


urlChanged()

Emitted when the url property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.6.


viewRefreshModeChanged()

Emitted when the viewRefreshMode property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.7.


viewRefreshTimeChanged()

Emitted when the viewRefreshTime property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.7.


Method Documentation

void refresh()

Refreshes the KML network link.

This QML method was introduced in Esri.ArcGISRuntime 100.7.



Feedback on this topic?