Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.layers

Enum Class GroupVisibilityMode

java.lang.Object
java.lang.Enum<GroupVisibilityMode>
com.esri.arcgisruntime.layers.GroupVisibilityMode
All Implemented Interfaces:
Serializable, Comparable<GroupVisibilityMode>, Constable
public enum GroupVisibilityMode extends Enum<GroupVisibilityMode>
Defines the visibility modes on a group layer.
Since:
100.9.0

  • Enum Constant Details

    • INDEPENDENT

      public static final GroupVisibilityMode INDEPENDENT
      Each child layer independently manages its visibility.

      In independent mode, a child layer's visibility property is independent of its parent's and siblings' visibility properties. Changes to the parent or siblings' visibility properties have no effect on the current layer's visibility property. However, the rendering of a child layer on the view requires both its visibility property and its parent's visibility property to be true. This can be visualized in the context of a table of contents. A parent can contain multiple child layers, each with a differing value of their visibility property. Turning off the parent's visibility will prevent any child layer from rendering on the view. But their visibility property will still be reflected in the table of contents. Setting the parent's visibility back to true returns the view to the original state.

      Since:
      100.9.0

    • INHERITED

      public static final GroupVisibilityMode INHERITED
      Each child inherits the visibility of its parent group.

      The visibility property of child layers is determined by the visibility of the parent layer and cannot be set independently of the parent. This means all child layers' visibility properties always match the visibility property of the parent. In an implementation of a table of contents, setting the parent's visibility to on or off will cause child layers to match. You may choose to hide all child layers from your table of contents given the group is treated as a single logical layer in terms of visibility.

      Since:
      100.9.0

    • EXCLUSIVE

      public static final GroupVisibilityMode EXCLUSIVE
      Only one child is visible at a time.

      In exclusive mode, only a single child may have its visible property set to true. When setting the visibility property of a child layer to true, all others will have their visibility set to false. However, the rendering of a child layer requires both its visibility property and its parent's visibility property to be true. In an implementation of a table of contents, a group layer will only ever contain one visible child layer.

      Since:
      100.9.0

  • Method Details

    • values

      public static GroupVisibilityMode[] 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 GroupVisibilityMode 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