Module com.esri.arcgisruntime
Enum Class LabelOverlapStrategy
- All Implemented Interfaces:
Serializable
,Comparable<LabelOverlapStrategy>
,Constable
The strategy for whether another label is allowed to be placed over this feature or label.
- Since:
- 100.11.0
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionThe other label will be allowed to place itself in its preferred location, ignoring this obstacle.The other label will use the default overlap behavior which depends on the object being overlapped.The other label will move to minimize overlapping this obstacle, but will overlap if necessary.The other label will be not be placed rather than overlap this obstacle. -
Method Summary
Modifier and TypeMethodDescriptionstatic LabelOverlapStrategy
Returns the enum constant of this class with the specified name.static LabelOverlapStrategy[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
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
The other label will be allowed to place itself in its preferred location, ignoring this obstacle.- Since:
- 100.11.0
-
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
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
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
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 nameNullPointerException
- if the argument is null
-