Enum LabelStackStrategy
- java.lang.Object
-
- java.lang.Enum<LabelStackStrategy>
-
- com.esri.arcgisruntime.mapping.labeling.LabelStackStrategy
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<LabelStackStrategy>
public enum LabelStackStrategy extends java.lang.Enum<LabelStackStrategy>
The strategy for whether the text should be stacked or wrapped, rather than place long trailing labels across the map.- Since:
- 100.11.0
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ALLOW
The label placement engine can break the text into two or more rows, if the rows are longer than theLabelDefinition.getStackRowLength()
limit.AUTOMATIC
Stacking will be enabled for some feature types.NONE
The text should not be broken, no matter how long it is.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static LabelStackStrategy
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static LabelStackStrategy[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
AUTOMATIC
public static final LabelStackStrategy AUTOMATIC
Stacking will be enabled for some feature types.The default stacking behavior for labels will depend on their feature type:
- Point feature labels may stack
- Line feature labels will not stack
- Polygon feature labels may stack.
- Since:
- 100.11.0
-
NONE
public static final LabelStackStrategy NONE
The text should not be broken, no matter how long it is.- Since:
- 100.11.0
-
ALLOW
public static final LabelStackStrategy ALLOW
The label placement engine can break the text into two or more rows, if the rows are longer than theLabelDefinition.getStackRowLength()
limit.- Since:
- 100.11.0
-
-
Method Detail
-
values
public static LabelStackStrategy[] 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 (LabelStackStrategy c : LabelStackStrategy.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static LabelStackStrategy 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 namejava.lang.NullPointerException
- if the argument is null
-
-