Skip To Content ArcGIS for Developers Sign In Dashboard

KmlDataset QML Type

Contains the current state of the KML data specified in a KML/KMZ file. More...

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

Object

Properties

Signals

Methods

Detailed Description

A KmlDataset may be created from a root KmlNode, which must be set immediately upon initialization using setInitRootNode.

This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.

See also Loadable and RemoteResource.

Property Documentation

[default] credential : Credential

The credential to be used for a secured online KML Dataset.


error : Error

Returns the error object (read-only).

See also Loadable and Error.


initRootNode : Error

The initial root node of this KmlDataset.

See also Loadable and Error.


loadError : Error

Returns the load error (read-only).

Note: load errors are also reported on the error property and emit the errorChanged signal.

See also Loadable.


loadStatus : Enums.LoadStatus

Returns the load status (read-only).

See also Loadable and Enums.LoadStatus.


[default] requestConfiguration : RequestConfiguration

The configuration parameters used for network requests sent by this dataset.


rootNodes : list<KmlNode>

Returns the KML dataset's root nodes.

KML files can have multiple root nodes, each of which may have children. When traversing the KML feature tree (for example to build a TOC), rootNodes is the correct starting point. Each root node can be the start of a tree of nodes.


url : url

The URL to the online KML Dataset.


Signal Documentation

credentialChanged()

Emitted when the credential property of this KmlDataset changes.


kmlNetworkLinkMessageReceived(KmlNetworkLink networkLink, string message)

Signal emitted when a KML dataset network link message is available.

This is used to deliver a popup message, such as usage guidelines for the network link. The message is available when the network link is first loaded, or when it is changed in the network link control.

  • networkLink - the KmlNetworkLink that had the new message.
  • message - the message.

kmlNodeRefreshStatusChanged(KmlNode target, Enums::KmlRefreshStatus refreshStatus)

Signal emitted when a KML refresh event is raised.

  • target - the node target for the event.
  • refreshStatus - the refresh status of the KML node.

See also Enums.KmlRefreshStatus.


loadErrorChanged()

Emitted when the loadError property of this KmlDataset changes.

Note: load errors are also reported on the error property and emit the errorChanged signal.

See also Loadable and Object.


loadStatusChanged()

Emitted when the loadStatus property of this KmlDataset changes.

See also Loadable.


requestConfigurationChanged()

Emitted when the requestConfiguration property changes.


rootNodesChanged()

Emitted when the rootNodes property changes.


urlChanged()

Emitted when the url property of this KmlDataset changes.


Method Documentation

void cancelLoad()

See also Loadable.


void load()

See also Loadable.


void retryLoad()

See also Loadable.



Feedback on this topic?