Enum Class LabelOverlapStrategy

java.lang.Object
java.lang.Enum<LabelOverlapStrategy>
com.esri.arcgisruntime.mapping.labeling.LabelOverlapStrategy
All Implemented Interfaces:
Serializable, Comparable<LabelOverlapStrategy>, Constable

public enum LabelOverlapStrategy extends Enum<LabelOverlapStrategy>
The strategy for whether another label is allowed to be placed over this feature or label.
Since:
100.11.0
  • Enum Constant Details

    • AUTOMATIC

      public static final LabelOverlapStrategy AUTOMATIC
      The other label will use the default overlap behavior which depends on the object being overlapped.

      This value corresponds to no value being specified for a LabelDefinition overlap property.

      Since:
      100.11.0
    • ALLOW

      public static final LabelOverlapStrategy ALLOW
      The other label will be allowed to place itself in its preferred location, ignoring this obstacle.
      Since:
      100.11.0
    • AVOID

      public static final LabelOverlapStrategy AVOID
      The other label will move to minimize overlapping this obstacle, but will overlap if necessary.

      The other label can only move if its LabelDefinition.getDeconflictionStrategy() allows.

      Since:
      100.11.0
    • EXCLUDE

      public static final LabelOverlapStrategy EXCLUDE
      The other label will be not be placed rather than overlap this obstacle.

      The other label can only move if its LabelDefinition.getDeconflictionStrategy() allows. If it cannot move, or if there is no free position available, then the other label will not be placed.

      Since:
      100.11.0
  • Method Details

    • values

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