KmlNode QML Type
A KML Node. More...
| Import Statement: | import Esri.ArcGISRuntime 100.8 |
| Since: | Esri.ArcGISRuntime 100.4 |
| Inherits: | |
| Inherited By: | KmlContainer, KmlGroundOverlay, KmlNetworkLink, KmlPhotoOverlay, KmlScreenOverlay, and KmlTour |
Properties
- address : string
- balloonBackgroundColor : color
- balloonContent : string
- description : string
- extent : Envelope
- highlightStyle : KmlStyle
- highlighted : bool
- kmlNodeId : string
- kmlNodeType : Enums.KmlNodeType
- name : string
- refreshError : Error
- refreshStatus : Enums.KmlRefreshStatus
- saveStatus : Enums.TaskStatus
- snippet : string
- snippetMaxLines : int
- style : KmlStyle
- uxIconColor : color
- uxIconId : int
- uxIconUrl : url
- viewpoint : KmlViewpoint
- visible : bool
Signals
- addressChanged()
- highlightStyleChanged()
- highlightedChanged()
- kmlNodeIdChanged()
- refreshErrorChanged()
- refreshStatusChanged()
- saveStatusChanged()
- styleChanged()
- uxIconColorChanged()
- uxIconIdChanged()
- uxIconUrlChanged()
- visibleChanged()
Methods
- void saveAs(url kmzFile)
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
Returns the address of the KML node.
Represents an unstructured address such as a street, city, state address, and/or a postal code.
This QML 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).
extent : Envelope |
Returns the extent for the KML node (read-only).
highlightStyle : KmlStyle |
The KML node's highlight style.
This style is used when the KML node has been highlighted / selected.
This QML property was introduced in Esri.ArcGISRuntime 100.7.
See also KmlStyle.
The ID of the KML node.
The kmlNodeId is a standard XML ID and can be empty.
This QML property was introduced in Esri.ArcGISRuntime 100.6.
Returns the Enums.KmlNodeType of this KML Node object (read-only).
refreshError : Error |
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 QML 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.
style : KmlStyle |
The KML node's style.
This QML property was introduced in Esri.ArcGISRuntime 100.7.
See also KmlStyle.
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 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).
Signal Documentation
Emitted when the highlightStyle property of this KmlNode changes.
This QML signal was introduced in Esri.ArcGISRuntime 100.7.
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
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
KMZfile is loaded. - For relative paths, the path is saved as-is and the referenced file is zipped relative to the root of the
KMZfile. - 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
KMZfile. For example,C:/icons/some_icon.pngis converted tofiles/some_icon.pngand stored at that location in theKMZfile.
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.