Package com.esri.arcgisruntime.ogc.kml

Enum KmlViewRefreshMode

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      NEVER
      Ignore changes in the view.
      ON_REGION
      Refresh the resource when the KML region becomes active.
      ON_REQUEST
      Refresh the resource only when the user explicitly requests it.
      ON_STOP
      Refresh the resource n milliseconds after movement stops, where n is specified by viewRefreshTime.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static KmlViewRefreshMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static KmlViewRefreshMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • 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:
        KmlNetworkLink.getViewRefreshTime()

      • 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 Detail

      • values

        public static KmlViewRefreshMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (KmlViewRefreshMode c : KmlViewRefreshMode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static KmlViewRefreshMode valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null