Contains the current state of the KML data specified in a KML/KMZ file. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.4 |
| Inherits: |
Properties
- credential : Credential
- error : Error
- initRootNode : Error
- loadError : Error
- loadStatus : Enums.LoadStatus
- requestConfiguration : RequestConfiguration
- rootNodes : list<KmlNode>
- url : url
Signals
- credentialChanged()
- initRootNodeChanged()
- kmlNetworkLinkMessageReceived(KmlNetworkLink networkLink, string message)
- kmlNodeBalloonVisibilityChanged(KmlNode target, bool balloonVisibility)
- kmlNodeRefreshStatusChanged(KmlNode target, Enums.KmlRefreshStatus refreshStatus)
- loadErrorChanged()
- loadStatusChanged()
- requestConfigurationChanged()
- rootNodesChanged()
- urlChanged()
Methods
- void cancelLoad()
- void load()
- void retryLoad()
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.
| Type | Default Property |
|---|---|
| Credential | credential |
| RequestConfiguration | requestConfiguration |
See also Loadable and RemoteResource.
Property Documentation
[default] credential : Credential |
The credential to be used for a secured online KML Dataset.
initRootNode : Error |
The initial root node of this KmlDataset.
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.
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.
Signal Documentation
Emitted when the credential property of this KmlDataset changes.
Note: The corresponding handler is onCredentialChanged.
Emitted when the initRootNode property changes.
Note: The corresponding handler is onInitRootNodeChanged.
This signal was introduced in Esri.ArcGISRuntime 100.6.
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.
Note: The corresponding handler is onKmlNetworkLinkMessageReceived.
kmlNodeBalloonVisibilityChanged(KmlNode target, bool balloonVisibility) |
Signal emitted whenever a KML node's balloon visibility changes.
- target - the node target for the balloon visibility event.
- balloonVisibility - the visibility for the balloon.
Note: The corresponding handler is onKmlNodeBalloonVisibilityChanged.
This signal was introduced in Esri.ArcGISRuntime 100.7.
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.
Note: The corresponding handler is onKmlNodeRefreshStatusChanged.
See also Enums.KmlRefreshStatus.
Emitted when the loadError property of this KmlDataset changes.
Note: load errors are also reported on the error property and emit the errorChanged signal.
Note: The corresponding handler is onLoadErrorChanged.
Emitted when the loadStatus property of this KmlDataset changes.
Note: The corresponding handler is onLoadStatusChanged.
See also Loadable.
Emitted when the requestConfiguration property changes.
Note: The corresponding handler is onRequestConfigurationChanged.
Emitted when the rootNodes property changes.
Note: The corresponding handler is onRootNodesChanged.
Emitted when the url property of this KmlDataset changes.
Note: The corresponding handler is onUrlChanged.
Method Documentation
See also Loadable.
See also Loadable.
See also Loadable.