KmlNetworkLink

Creates a KML network link from the provided URI to a KML/KMZ file. Creates a KML network link that references a KML file or KMZ archive on a local or remote network.

True if the app should zoom to the KML network link when it refreshes, false otherwise. When this is defined, the app should zoom to the viewpoint defined on the associated NetworkLinkControl or the network links' top-level KML node upon refresh of the link. The app will not automatically fly to the node on refresh. It is the application developer's responsibility to implement this behavior, if desired. You can listen for the refresh status changed event to detect when the geoview's viewpoint should be updated. This is defined in the flyToView tag in the network link.

The KML network link's child nodes.

True if the visibility selection is preserved for nodes in a network link after refresh, false otherwise. This corresponds to the 'refreshVisibility' property in the source KML file.

True if the KML network link is open, false otherwise.

True if the KML network link is partially visible, false otherwise.

The network link's list item type. This defines how visibility selection should work, enabling either single or multiple selection of child nodes when shown in a list (for example, a legend). When the item type is KmlListItemType.RadioFolder, making a node visible will hide its sibling nodes. See the OGC specification for more details.

The KML network link refresh interval, in milliseconds.

The KML network link refresh mode.

The KML network link URI. After setting a new URI you should call KmlNetworkLink.refresh to fetch the data from the new URI. If the refresh mode of the network link is KmlRefreshMode.OnInterval when the URI is changed, the refresh operation executed on the following interval will use the new URI value.

The scale factor to apply to the bounding box parameters when retrieving the network link. Only applied if KmlViewRefreshMode is a value other than KmlViewRefreshMode.Never. A value of 1.0 covers the visible extent. Values less than 1.0 specifies to use less than visible extent, while values greater than 1.0 specifies to use beyond visible extent. The default value is 1.0. Refer to the KML Link documentation for more details.

The KML network link view refresh mode.

The KML network link view refresh time, in milliseconds.

The address of the KML node. An unstructured address such as a street, city, state address, and/or a postal code.

The color to be used for the KML node balloon. A color mask that can be used to color the balloon of a KML node. This color can be used for the UI "chrome" that presents the KmlNode.balloonContent, such as the background color of a callout.

The balloon content that should be displayed in a balloon popup for the KML node. The provided HTML is suitable for display in a web view.

The description of the KML node.

The non-schema data present in the extended data of a KML node.

A collection of schema data present in the extended data of a KML node. Adding a unique KmlSchemaData.schema object also adds it to KmlDocument.schemas.

The extent for the KML node.

The KML node's highlight style. This style is used when the KML node has been highlighted / selected.

The ID of the KML node. The ID is a standard XML ID and can be empty.

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

True if the KML node is visible, false otherwise. In order for a node to be visible, all of its ancestors must also be visible. Changing the visibility of one node may affect visibility of other nodes in the dataset hierarchy, such as child nodes. All of the connected map views will be updated.

The name of the KML node.

The KML node's parent.

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

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 KmlNode.description. The maximum number of lines to display is specified by the KmlNode.snippetMaxLines property.

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

The KML node's style.

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

The UX icon of a KML node. Use this icon to represent the KML node in the TOC or list item or any UI element.

The color mask used to tint the node's icon. 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.

The UX icon id. The icon id associate with KML node.

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

Refreshes the KML network link.

Saves the node and any referenced local files into a zipped KMZ archive. 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. Saving referenced files will differ based on the type of reference. For HTTP paths, the path will be saved as is but the referenced file will not be zipped into the archive, as it will simply be refetched when the new KMZ is loaded. For relative paths, the path will be saved as is and the referenced file will be zipped relative to the root of the KMZ file. For absolute paths, the path will be converted to a relative path, and the referenced file will be zipped into a "files" folder at the root of the KMZ file. For example, "C:/icons/some_icon.png" would be 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. It must be non-empty and there must not be an existing file located there. Saving a node to a KMZ file requires an ArcGIS Runtime 'Standard' license level.