KmlNode QML Type

  • Esri.ArcGISRuntime
  • KmlNode
  • A KML Node. More...

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

    Object

    Inherited By:

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

    Properties

    Signals

    Methods

    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

    KmlContainer

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

    KmlGroundOverlay

    An image overlay draped over the terrain

    KmlNetworkLink

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

    KmlPhotoOverlay

    A photo overlay draped on a shape

    KmlPlacemark

    A KML node with associated Geometry

    KmlScreenOverlay

    An image overlay fixed to the screen

    KmlTour

    An execution of a KML Playlist

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

    Property Documentation

    [since Esri.ArcGISRuntime 100.7] address : string

    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.


    [read-only] balloonBackgroundColor : color

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


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


    [read-only] extent : Envelope

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


    [since Esri.ArcGISRuntime 100.7] highlightStyle : KmlStyle

    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.


    highlighted : bool

    Whether the KML node is highlighted.

    Highlights the node if is_highlighted is true, unhighlights it otherwise. All of the connected map views will be updated. This controls whether the default style or an alternate 'highlighted' style (if present) is used for rendering the node. This is unrelated to the concept of selection in this API.


    [since Esri.ArcGISRuntime 100.6] kmlNodeId : string

    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.


    [read-only] kmlNodeType : Enums.KmlNodeType

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


    name : string

    Returns the name of the KML node.


    [read-only] parentNode : KmlNode

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


    [read-only] refreshError : Error

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


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


    [read-only, since Esri.ArcGISRuntime 100.6] saveStatus : Enums.TaskStatus

    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.


    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.


    [since Esri.ArcGISRuntime 100.7] style : KmlStyle

    The KML node's style.

    This property was introduced in Esri.ArcGISRuntime 100.7.

    See also KmlStyle.


    [since Esri::ArcGISRuntime 100.11] timeExtent : TimeExtent

    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:

    Kml TimeStampTimeExtent::startTimeTimeExtent::endTime
    20212021-01-01T00:00:002021-12-31T23:59:59
    2021-012021-01-01T00:00:002021-01-31T23:59:59
    2021-01-012021-01-01T00:00:002021-01-01T23:59:59
    2021-01-01T12:34:562021-01-01T12:34:562021-01-01T12:34:56
    Kml TimeSpanTimeExtent::startTimeTimeExtent::endTime
    2021 - 20222021-01-01T00:00:002022-12-31T23:59:59
    2021-012021-01-01T00:00:002021-02-28T23:59:59
    No beginning - 2021Infinite start time2021-12-31T23:59:59
    2021 - No end2021-01-01T00:00:00Infinite end time

    This property was introduced in Esri::ArcGISRuntime 100.11.


    [read-only] uxIconColor : color

    Returns the color mask used to tint the node's icon. (read-only).

    A color mask that can be used to blend the image associated with the KML node. Pixels in the image are multiplied by this color channel-by-channel. Colors in KML are specified in ABGR order. When no UX icon is specified, you can use this color to draw a placeholder for use in the UI (for example, a legend). UX icons are not pre-tinted; it is the application's responsibility to apply the tint color to the UX icon before displaying it.


    [read-only] uxIconId : int

    Returns the UX icon id (read-only).


    [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

    [since Esri.ArcGISRuntime 100.7] addressChanged()

    Emitted when the address property of this KmlNode changes.

    Note: The corresponding handler is onAddressChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.7.


    [since Esri.ArcGISRuntime 100.6] descriptionChanged()

    Emitted when the description property of this KmlNode changes.

    Note: The corresponding handler is onDescriptionChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.6.


    [since Esri.ArcGISRuntime 100.7] highlightStyleChanged()

    Emitted when the highlightStyle property of this KmlNode changes.

    Note: The corresponding handler is onHighlightStyleChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.7.


    highlightedChanged()

    Emitted when the highlighted property changes.

    Note: The corresponding handler is onHighlightedChanged.


    [since Esri.ArcGISRuntime 100.6] kmlNodeIdChanged()

    Emitted when the kmlNodeId property of this KmlNode changes.

    Note: The corresponding handler is onKmlNodeIdChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.6.


    [since Esri.ArcGISRuntime 100.6] nameChanged()

    Emitted when the name property of this KmlNode changes.

    Note: The corresponding handler is onNameChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.6.


    refreshErrorChanged()

    Emitted when the refreshError property changes.

    Note: The corresponding handler is onRefreshErrorChanged.


    refreshStatusChanged()

    Emitted when the refreshStatus property changes.

    Note: The corresponding handler is onRefreshStatusChanged.


    [since Esri.ArcGISRuntime 100.6] saveStatusChanged()

    Emitted when the saveStatus property of this KmlNode changes.

    Note: The corresponding handler is onSaveStatusChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.6.


    [since Esri.ArcGISRuntime 100.6] snippetChanged()

    Emitted when the snippet property of this KmlNode changes.

    Note: The corresponding handler is onSnippetChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.6.


    [since Esri.ArcGISRuntime 100.6] snippetMaxLinesChanged()

    Emitted when the snippetMaxLines property of this KmlNode changes.

    Note: The corresponding handler is onSnippetMaxLinesChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.6.


    [since Esri.ArcGISRuntime 100.7] styleChanged()

    Emitted when the style property of this KmlNode changes.

    Note: The corresponding handler is onStyleChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.7.


    [since Esri.ArcGISRuntime 100.11] timeExtentChanged()

    Emitted when the timeExtent property changes.

    Note: The corresponding handler is onTimeExtentChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.11.


    uxIconColorChanged()

    Emitted when the uxIconColor property changes.

    Note: The corresponding handler is onUxIconColorChanged.


    uxIconIdChanged()

    Emitted when the uxIconId property changes.

    Note: The corresponding handler is onUxIconIdChanged.


    uxIconUrlChanged()

    Emitted when the uxIconUrl property changes.

    Note: The corresponding handler is onUxIconUrlChanged.


    [since Esri.ArcGISRuntime 100.6] viewpointChanged()

    Emitted when the viewpoint property of this KmlNode changes.

    Note: The corresponding handler is onViewpointChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.6.


    visibleChanged()

    Emitted when the visible property changes.

    Note: The corresponding handler is onVisibleChanged.


    Method Documentation

    [since Esri.ArcGISRuntime 100.6] void saveAs(url kmzFile)

    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.


    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.