Package com.esri.arcgisruntime.mapping.labeling

Enum LabelStackAlignment

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<LabelStackAlignment>
    public enum LabelStackAlignment
extends java.lang.Enum<LabelStackAlignment>
    The strategy for how multi-row (stacked) text should be horizontally aligned.

    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

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static LabelStackAlignment valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static LabelStackAlignment[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • DYNAMIC

        public static final LabelStackAlignment 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

    • Method Detail

      • values

        public static LabelStackAlignment[] 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 (LabelStackAlignment c : LabelStackAlignment.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static LabelStackAlignment 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 name
        java.lang.NullPointerException - if the argument is null