KmlNetworkLink QML Type

  • Esri.ArcGISRuntime
  • KmlNetworkLink
  • A reference to a KML file or KMZ archive on a local or remote network. More...

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

    KmlNode

    Properties

    Signals

    Methods

    Detailed Description

    Property Documentation

    canFlyToNode : bool

    A flag, true if the app should zoom to the KmlNetworkLink 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.

    This property is writable as of Esri.ArcGISRuntime 100.6

    Note: It is the developer's responsibility to implement this behavior if desired.


    [read-only] childNodes : list<KmlNode>

    Returns the KML network link's child nodes.


    hasRefreshVisibility : bool

    A flag, 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.

    This property is writable as of Esri.ArcGISRuntime 100.6


    listItemType : Enums.KmlListItemType

    A flag, indicating the network link's list item type.

    This property is writable as of Esri.ArcGISRuntime 100.6

    See also Enums.KmlListItemType.


    open : bool

    A flag, true if the KML network link is open, false otherwise.


    [read-only] partiallyVisible : bool

    A flag, true if the KML network link is open, false otherwise.


    [since Esri.ArcGISRuntime 100.7] refreshInterval : string

    The KML network link refresh interval, in milliseconds.

    Note: The underlying property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

    This property was introduced in Esri.ArcGISRuntime 100.7.

    See also refreshIntervalAsInt.


    [since Esri.ArcGISRuntime 100.7] refreshIntervalAsInt : int

    The KML network link refresh interval, in milliseconds, but represented as an integer type.

    Note: The underlying property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

    This property was introduced in Esri.ArcGISRuntime 100.7.


    refreshMode : Enums.KmlRefreshMode

    The KML network link refresh mode.

    This property is writable as of Esri.ArcGISRuntime 100.7

    See also Enums.KmlRefreshMode.


    url : url

    URL, indicating the KML network link's data path.

    This property is writable as of Esri.ArcGISRuntime 100.6

    After setting a new URL, call refresh to fetch the data from the new URL. If the refresh mode of the network link is Enums.KmlRefreshModeOnInterval when the URL is changed, the refresh operation executed on the following interval will use the new URL.


    viewRefreshMode : Enums.KmlViewRefreshMode

    The KML network link view refresh mode.

    This property is writable as of Esri.ArcGISRuntime 100.7

    See also Enums.KmlViewRefreshMode.


    [since Esri.ArcGISRuntime 100.7] viewRefreshTime : string

    The KML network link view refresh time, in milliseconds.

    Note: The underlying property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

    This property was introduced in Esri.ArcGISRuntime 100.7.

    See also viewRefreshTimeAsInt.


    [since Esri.ArcGISRuntime 100.7] viewRefreshTimeAsInt : int

    The KML network link view refresh time, in milliseconds, but represented as an integer type.

    Note: The underlying property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

    This property was introduced in Esri.ArcGISRuntime 100.7.


    Signal Documentation

    [since Esri.ArcGISRuntime 100.6] canFlyToNodeChanged()

    Emitted when the canFlyToNode property changes.

    Note: The corresponding handler is onCanFlyToNodeChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.6.


    childNodesChanged()

    Emitted when the childNodes property changes.

    Note: The corresponding handler is onChildNodesChanged.


    [since Esri.ArcGISRuntime 100.6] hasRefreshVisibilityChanged()

    Emitted when the hasRefreshVisibility property changes.

    Note: The corresponding handler is onHasRefreshVisibilityChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.6.


    [since Esri.ArcGISRuntime 100.6] listItemTypeChanged()

    Emitted when the listItemTypeChanged property changes.

    Note: The corresponding handler is onListItemTypeChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.6.


    openChanged()

    Emitted when the open property changes.

    Note: The corresponding handler is onOpenChanged.


    partiallyVisibleChanged()

    Emitted when the partiallyVisible property changes.

    Note: The corresponding handler is onPartiallyVisibleChanged.


    [since Esri.ArcGISRuntime 100.7] refreshIntervalChanged()

    Emitted when the refreshInterval property changes.

    Note: The corresponding handler is onRefreshIntervalChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.7.


    [since Esri.ArcGISRuntime 100.7] refreshModeChanged()

    Emitted when the refreshMode property changes.

    Note: The corresponding handler is onRefreshModeChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.7.


    [since Esri.ArcGISRuntime 100.6] urlChanged()

    Emitted when the url property changes.

    Note: The corresponding handler is onUrlChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.6.


    [since Esri.ArcGISRuntime 100.7] viewRefreshModeChanged()

    Emitted when the viewRefreshMode property changes.

    Note: The corresponding handler is onViewRefreshModeChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.7.


    [since Esri.ArcGISRuntime 100.7] viewRefreshTimeChanged()

    Emitted when the viewRefreshTime property changes.

    Note: The corresponding handler is onViewRefreshTimeChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.7.


    Method Documentation

    [since Esri.ArcGISRuntime 100.7] void refresh()

    Refreshes the KML network link.

    This method was introduced in Esri.ArcGISRuntime 100.7.


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