KmlDataset

A KML dataset object. KML dataset represents the current state of the KML data specified in a KML/KMZ file.

Since

200.1.0

Constructors

Link copied to clipboard
constructor(rootNode: KmlNode)

Creates a KML dataset from the specified root node. Creates a KML dataset. KML dataset is the source of KML information backing a KML layer. 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. Creates a KML dataset. KML dataset is the source of KML information backing a KML layer. 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 any KML node's balloon visibility changes. Set this callback to know when to show or hide a KML node's balloon popup.

Link copied to clipboard

Sets the callback that gets invoked when a KML refresh event is raised on a KML node. Set a KML dataset refresh callback 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.