Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.ogc.kml

Enum Class KmlViewRefreshMode

java.lang.Object
java.lang.Enum<KmlViewRefreshMode>
com.esri.arcgisruntime.ogc.kml.KmlViewRefreshMode
All Implemented Interfaces:
Serializable, Comparable<KmlViewRefreshMode>, Constable
public enum KmlViewRefreshMode extends Enum<KmlViewRefreshMode>
List of KML view refresh modes.

Defines the view-based refresh behavior of a KML network link or an image overlay.

Since:
100.6.0
See Also:

  • Enum Constant Details

    • NEVER

      public static final KmlViewRefreshMode NEVER
      Ignore changes in the view.
      Since:
      100.6.0

    • ON_STOP

      public static final KmlViewRefreshMode ON_STOP
      Refresh the resource n milliseconds after movement stops, where n is specified by viewRefreshTime.

      If viewRefreshTime is not set when the mode is set to ON_STOP, it will automatically update the viewRefreshTime to 4000 milliseconds.

      Since:
      100.6.0
      See Also:

    • ON_REQUEST

      public static final KmlViewRefreshMode ON_REQUEST
      Refresh the resource only when the user explicitly requests it.
      Since:
      100.6.0

    • ON_REGION

      public static final KmlViewRefreshMode ON_REGION
      Refresh the resource when the KML region becomes active.

      A KML region affects visibility of a KML node, e.g a KmlPlacemark or KmlNetworkLink etc. KML regions define both culling and level-of-detail control over the display of nodes. A KML region is said to be "active" when the bounding box defined in the node is within the user's view and the LOD requirements are met.

      Since:
      100.6.0

  • Method Details

    • values

      public static KmlViewRefreshMode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static KmlViewRefreshMode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null