Skip To Content ArcGIS for Developers Sign In Dashboard

KmlNode QML Type

A KML Node. More...

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


Inherited By:

KmlContainer, KmlGroundOverlay, KmlNetworkLink, KmlPhotoOverlay, KmlScreenOverlay, and KmlTour




Detailed Description

KML is a file format used to display geographic data (geometric shapes, symbology and attributes). KML uses a tag-based structure with nested elements and attributes and is based on the XML standard. The KML files are often distributed in KMZ files, which are zipped KML files with a .kmz extension.

Types that implement KmlNode


Holds one or more KML nodes and allows the creation of nested hierarchies


An image overlay draped over the terrain


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


A photo overlay draped on a shape


A KML node with associated Geometry


An image overlay fixed to the screen


An execution of a KML Playlist

Note: You cannot declare or create a component of this type in QML code.

Property Documentation

balloonBackgroundColor : color

Returns the color mask to be applied to the KML node's balloon border (read-only).

balloonContent : string

Returns the balloon content that should be displayed in a balloon popup for the KML node (read-only).

description : string

Returns the description of the KML node.

extent : Envelope

Returns the extent for the KML node (read-only).

highlighted : bool

Whether the KML node is highlighted.

kmlNodeId : string

The ID of the KML node.

The kmlNodeId is a standard XML ID and can be empty.

kmlNodeType : Enums.KmlNodeType

Returns the Enums.KmlNodeType of this KML Node object (read-only).

name : string

Returns the name of the KML node.

refreshError : Error

Returns the refresh error of this KML Node object (read-only).

refreshStatus : Enums.KmlRefreshStatus

Returns the Enums.KmlRefreshStatus of this KML Node object (read-only).

Use the node refresh status to update the node's properties and update application UI.

  • Enums.KmlRefreshStatusNone - No action required.
  • Enums.KmlRefreshStatusInProgress - Invalidate the node and its children. Application may show an appropriate UI cue such as a spinning wheel on top of the node's TOC icon to indicate in-progress status and to restrict user interaction with the node.
  • Enums.KmlRefreshStatusCompleted - Read and update the node's properties and its children.
  • Enums.KmlRefreshStatusError - Application may call refreshError to get the reason for failure and show the error message. Also, applications may show an appropriate UI cue such as a red X with the node's TOC icon to indicate the failed status.

See also refreshError.

saveStatus : Enums.TaskStatus

The save status of the asynchronous saveAs operation:

Check this status when the saveStatusChanged signal emits.

This QML property was introduced in Esri.ArcGISRuntime 100.6.

See also Enums.TaskStatus.

snippet : string

Returns the KML node's snippet.

Snippets can be defined for KML nodes as an additional short description for UI display. If no snippet is specified, you can take the first few lines of the description. The maximum number of lines to display is specified by the snippetMaxLines property.

snippetMaxLines : int

Returns the maximum number of lines of snippet to be shown in the UI.

uxIconColor : color

Returns the color mask to be applied to the KML node's image buffer (read-only).

Returns a color mask that can be used to blend the image associated with KML node.

uxIconId : int

Returns the UX icon id (read-only).

uxIconUrl : url

Returns the image URL to the UX icon of a KML node (read-only).

The imageUrl may be intially empty, but uxIconUrlChanged will emit once the url is available.

viewpoint : KmlViewpoint

Returns the KML node's viewpoint.

The KML viewpoint is the specified vantage point for looking at the node. This can be used to show a particular node in the view (for example, if a user selected it in a TOC).

visible : bool

Whether the KML node is visible.

Signal Documentation


Emitted when the highlighted property changes.


Emitted when the refreshError property changes.


Emitted when the refreshStatus property changes.


Emitted when the saveStatus property of this KmlNode changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.6.


Emitted when the uxIconColor property changes.


Emitted when the uxIconId property changes.


Emitted when the uxIconUrl property changes.


Emitted when the visible property changes.

Method Documentation

void saveAs(url kmzFile)

Saves the node and any referenced local files into a zipped KMZ archive at local file path /a kmzFile.

The node will be saved to a KMZ file to ensure that any referenced files are available locally when sharing the file with others. If this method is called on a leaf node (e.g. KmlPlacemark, KmlGroundOverlay, etc.), only that node and its referenced files will be saved. If this method is called on container node (e.g. KmlDocument, KmlFolder), the node and all of its children and referenced files will be saved. If this method is called on a KmlNetworkLink, the link will be saved but the children will not. This is because the children will simply be refetched when the saved KmlNetworkLink is loaded. The filename supports unicode characters as well as nested directories.

The saveStatus property shows the progress of a saveAs operation.

This QML method was introduced in Esri.ArcGISRuntime 100.6.

Feedback on this topic?