KmlDataset

A KML dataset represents the current state of the KML data specified in a KML/KMZ file. The KML Dataset provides an entry point to traverse the tree of KML nodes that make up the KML document. You can create a KML dataset from an existing KML/KMZ file by using KmlDataset.KmlDataset or you can create a new KML dataset by using a specified root node (KmlDataset.KmlDataset).

Since

200.1.0

Constructors

Link copied to clipboard
constructor(rootNode: KmlNode)

Creates a KML dataset from the specified root node. KML dataset is the source of KML information backing a KML layer. You can use the KML dataset to interact with the contents of a KML layer. Licensing for KML depends on the method of access. Creating a KML dataset from a root node requires an ArcGIS Runtime 'Standard' license level.

constructor(uri: String)

Creates a KML dataset from the provided path to a KML/KMZ file. KML dataset is the source of KML information backing a KML layer. You can use the KML dataset to interact with the contents of a KML layer. Licensing for KML depends on the method of access. Accessing files on disk requires an ArcGIS Runtime 'Standard' license level.

Properties

Link copied to clipboard

Sets the callback that gets invoked when a KML dataset network link message is available. This is used to deliver a pop-up 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.

Link copied to clipboard

A SharedFlow that emits when any KML node's balloon visibility changes. Use this to know when to show or hide a KML node's balloon popup.

Link copied to clipboard

A SharedFlow that emits when a KML refresh event is raised on a KML node. Use this to observe KML node refreshes.

Link copied to clipboard

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), KmlDataset.rootNodes is the correct starting point. Each root node can be the start of a tree of nodes, so these should be recursively explored with KmlContainer.childNodes or KmlNetworkLink.childNodes.

Link copied to clipboard
val uri: String?

The location of the KML/KMZ file, which can either be on disk or from the network. The URI of the backing file. Files can be loaded from local storage or the network. Note that KML files often point to network locations for their data (using network links). As a result, the loaded KML layer may display more information than is contained in the loaded KML file. KML files can point to network locations. These locations may be insecure (over plain text HTTP) even when the URI returned from this function is pointing to an SSL/TLS-secured resource.

Inherited properties

Link copied to clipboard
open override val loadStatus: StateFlow<LoadStatus>

The load status.

Inherited functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

Link copied to clipboard
open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

Link copied to clipboard
open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.