Enum Class LabelStackAlignment
- All Implemented Interfaces:
Serializable
,Comparable<LabelStackAlignment>
,Constable
Multi-row text labels can each be horizontally aligned on the left, right or at their center. By using the
LabelStackAlignment, the user can choose to use the
TextSymbol.getHorizontalAlignment()
property for all labels, or can choose
to have the most aesthetic alignment calculated case-by-case for each label depending on its placement position
around its feature. This is particularly useful for labels of dense point features, where labels may move above,
below, left, or right of their point symbol, in order to fit on the display.
- 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 default behavior is to useTEXT_SYMBOL
.Set the alignment depending upon the label's position with respect to its feature.Follow the alignment specified by theTextSymbol.getHorizontalAlignment()
. -
Method Summary
Modifier and TypeMethodDescriptionstatic LabelStackAlignment
Returns the enum constant of this class with the specified name.static LabelStackAlignment[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
AUTOMATIC
The default behavior is to useTEXT_SYMBOL
.This value corresponds to no value being specified for a
LabelDefinition.getStackAlignment()
property.- Since:
- 100.11.0
-
DYNAMIC
Set the alignment depending upon the label's position with respect to its feature.Have the alignment decided case-by-case for each label depending on its placement position around its feature. This is particularly useful for labels of dense point features, where labels may move above, below, left, or right of their point symbol, in order to fit on the display. For example, a stack to the right of a point symbol will be left-aligned.
- Since:
- 100.11.0
-
TEXT_SYMBOL
Follow the alignment specified by theTextSymbol.getHorizontalAlignment()
.- 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
-