KmlNode QML Type

Returns the address of the KML node.

Represents an unstructured address such as a street, city, state address, and/or a postal code.

This property was introduced in Esri.ArcGISRuntime 100.7.

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

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

Returns the description of the KML node.

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

The KML node's highlight style.

This style is used when the KML node has been highlighted / selected.

This property was introduced in Esri.ArcGISRuntime 100.7.

See also KmlStyle.

Whether the KML node is highlighted.

The ID of the KML node.

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

This property was introduced in Esri.ArcGISRuntime 100.6.

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

Returns the name of the KML node.

Returns the parent node of this KML node (read-only).

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

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.

The save status of the asynchronous saveAs operation:

Check this status when the saveStatusChanged signal emits.

This property was introduced in Esri.ArcGISRuntime 100.6.

See also Enums.TaskStatus.

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.

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

The KML node's style.

This property was introduced in Esri.ArcGISRuntime 100.7.

See also KmlStyle.

Returns the KML node's time extent.

Represents the TimeExtent equivalent of a KML node's TimeStamp or TimeSpan. A KmlContainer node such as KmlDocument or KmlFolder may have its own TimeExtent independent of its child nodes. All KML TimeStamps and TimeSpans specified in a KML/KMZ file are converted to their UTC TimeExtent equivalents.

Examples:

This property was introduced in Esri::ArcGISRuntime 100.11.

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.

Returns the UX icon id (read-only).

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.

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).

Whether the KML node is visible.

Emitted when the address property of this KmlNode changes.

Note: The corresponding handler is onAddressChanged.

This signal was introduced in Esri.ArcGISRuntime 100.7.

Emitted when the description property of this KmlNode changes.

Note: The corresponding handler is onDescriptionChanged.

This signal was introduced in Esri.ArcGISRuntime 100.6.

Emitted when the highlightStyle property of this KmlNode changes.

Note: The corresponding handler is onHighlightStyleChanged.

This signal was introduced in Esri.ArcGISRuntime 100.7.

Emitted when the highlighted property changes.

Note: The corresponding handler is onHighlightedChanged.

Emitted when the kmlNodeId property of this KmlNode changes.

Note: The corresponding handler is onKmlNodeIdChanged.

This signal was introduced in Esri.ArcGISRuntime 100.6.

Emitted when the name property of this KmlNode changes.

Note: The corresponding handler is onNameChanged.

This signal was introduced in Esri.ArcGISRuntime 100.6.

Emitted when the refreshError property changes.

Note: The corresponding handler is onRefreshErrorChanged.

Emitted when the refreshStatus property changes.

Note: The corresponding handler is onRefreshStatusChanged.

Emitted when the saveStatus property of this KmlNode changes.

Note: The corresponding handler is onSaveStatusChanged.

This signal was introduced in Esri.ArcGISRuntime 100.6.

Emitted when the snippet property of this KmlNode changes.

Note: The corresponding handler is onSnippetChanged.

This signal was introduced in Esri.ArcGISRuntime 100.6.

Emitted when the snippetMaxLines property of this KmlNode changes.

Note: The corresponding handler is onSnippetMaxLinesChanged.

This signal was introduced in Esri.ArcGISRuntime 100.6.

Emitted when the style property of this KmlNode changes.

Note: The corresponding handler is onStyleChanged.

This signal was introduced in Esri.ArcGISRuntime 100.7.

Emitted when the timeExtent property changes.

Note: The corresponding handler is onTimeExtentChanged.

This signal was introduced in Esri.ArcGISRuntime 100.11.

Emitted when the uxIconColor property changes.

Note: The corresponding handler is onUxIconColorChanged.

Emitted when the uxIconId property changes.

Note: The corresponding handler is onUxIconIdChanged.

Emitted when the uxIconUrl property changes.

Note: The corresponding handler is onUxIconUrlChanged.

Emitted when the viewpoint property of this KmlNode changes.

Note: The corresponding handler is onViewpointChanged.

This signal was introduced in Esri.ArcGISRuntime 100.6.

Emitted when the visible property changes.

Note: The corresponding handler is onVisibleChanged.

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

The node is saved to a KMZ file to ensure that any referenced files are available locally when sharing the KMZ file with others.

• When this method is called on a leaf node (e.g. KmlPlacemark, KmlGroundOverlay, and so on), only that node and its referenced files are saved.
• When this method is called on a container node (e.g. KmlDocument, KmlFolder), the node and all of its children and referenced files are saved.
• When this method is called on a KmlNetworkLink, the link is saved but the children are not. This is because the children will be refetched when the saved KmlNetworkLink is loaded.

Saving referenced files will differ based on the type of path used for reference.

• For HTTP paths, the path is saved as-is but the referenced file is not zipped into the archive, as it will be refetched when the new KMZ file is loaded.
• For relative paths, the path is saved as-is and the referenced file is zipped relative to the root of the KMZ file.
• For absolute paths, the path is converted to a relative path, and the referenced file is zipped into a "files" folder at the root of the KMZ file. For example, C:/icons/some_icon.png is converted to files/some_icon.png and stored at that location in the KMZ file.

The filename supports Unicode characters as well as nested directories

The saveStatus property shows the progress of a saveAs operation.

This method was introduced in Esri.ArcGISRuntime 100.6.