Enum LabelingPlacement

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<LabelingPlacement>

    public enum LabelingPlacement
    extends java.lang.Enum<LabelingPlacement>
    Defines the labeling placement options. This is used to specify the preferred position of the text label, with respect to its feature geometry.
    Since:
    100.0.0
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AUTOMATIC
      Default position for the label, dependent on the type of feature being labeled.
      LINE_ABOVE_AFTER
      Lower-left corner of label is at final geometry coord, label extrapolates the last geometry segment.
      LINE_ABOVE_ALONG
      Lower midpoint of label prefers the midpoint of the geometry, label follows the geometry segments.
      LINE_ABOVE_BEFORE
      Lower right corner of label is at first geometry coord, label extrapolates the first geometry segment.
      LINE_ABOVE_END
      Lower right corner of label is at final geometry coord, label follows the last geometry segments.
      LINE_ABOVE_START
      Lower left corner of label is at first geometry coord, label follows the first geometry segments.
      LINE_BELOW_AFTER
      Upper left corner of label is at final geometry coord, label extrapolates the last geometry segment.
      LINE_BELOW_ALONG
      Upper midpoint of label prefers the midpoint of the geometry, label follows the geometry segments.
      LINE_BELOW_BEFORE
      Upper right corner of label is at first geometry coord, label extrapolates the first geometry segment.
      LINE_BELOW_END
      Upper right corner of label is at final geometry coord, label follows the last geometry segments.
      LINE_BELOW_START
      Upper left corner of label is at first geometry coord, label follows the first geometry segments.
      LINE_CENTER_AFTER
      Left midpoint of label is at final geometry coord, label extrapolates the last geometry segment.
      LINE_CENTER_ALONG
      Center of label prefers the midpoint of the geometry, label follows the geometry segments.
      LINE_CENTER_BEFORE
      Right midpoint of label is at first geometry coord, label extrapolates the first geometry segment.
      LINE_CENTER_END
      Right midpoint of label is at final geometry coord, label follows the last geometry segments.
      LINE_CENTER_START
      Left midpoint of label is at first geometry coord, label follows the first geometry segments.
      POINT_ABOVE_CENTER
      Lower midpoint of label is offset north of point symbol.
      POINT_ABOVE_LEFT
      Lower right corner of the label is offset northwest of point symbol.
      POINT_ABOVE_RIGHT
      Lower left corner of the label is offset northeast of point symbol.
      POINT_BELOW_CENTER
      Upper midpoint of label is offset south of point symbol.
      POINT_BELOW_LEFT
      Upper right corner of the label is offset southwest of point symbol.
      POINT_BELOW_RIGHT
      Upper left corner of the label is offset South-east of point symbol.
      POINT_CENTER_CENTER
      Center of label is placed on geometry point.
      POINT_CENTER_LEFT
      Right midpoint of label is offset West of point symbol.
      POINT_CENTER_RIGHT
      Left midpoint of label is offset East of point symbol.
      POLYGON_ALWAYS_HORIZONTAL
      Center of label is as far inside polygon as possible.
      UNKNOWN
      Preferred placement position has not been specified.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static LabelingPlacement valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static LabelingPlacement[] 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

      • UNKNOWN

        public static final LabelingPlacement UNKNOWN
        Preferred placement position has not been specified.
        Since:
        100.0.0
      • AUTOMATIC

        public static final LabelingPlacement AUTOMATIC
        Default position for the label, dependent on the type of feature being labeled.
        Since:
        100.11.0
      • LINE_ABOVE_AFTER

        public static final LabelingPlacement LINE_ABOVE_AFTER
        Lower-left corner of label is at final geometry coord, label extrapolates the last geometry segment.
        Since:
        100.0.0
      • LINE_ABOVE_ALONG

        public static final LabelingPlacement LINE_ABOVE_ALONG
        Lower midpoint of label prefers the midpoint of the geometry, label follows the geometry segments.
        Since:
        100.0.0
      • LINE_ABOVE_BEFORE

        public static final LabelingPlacement LINE_ABOVE_BEFORE
        Lower right corner of label is at first geometry coord, label extrapolates the first geometry segment.
        Since:
        100.0.0
      • LINE_ABOVE_END

        public static final LabelingPlacement LINE_ABOVE_END
        Lower right corner of label is at final geometry coord, label follows the last geometry segments.
        Since:
        100.0.0
      • LINE_ABOVE_START

        public static final LabelingPlacement LINE_ABOVE_START
        Lower left corner of label is at first geometry coord, label follows the first geometry segments.
        Since:
        100.0.0
      • LINE_BELOW_AFTER

        public static final LabelingPlacement LINE_BELOW_AFTER
        Upper left corner of label is at final geometry coord, label extrapolates the last geometry segment.
        Since:
        100.0.0
      • LINE_BELOW_ALONG

        public static final LabelingPlacement LINE_BELOW_ALONG
        Upper midpoint of label prefers the midpoint of the geometry, label follows the geometry segments.
        Since:
        100.0.0
      • LINE_BELOW_BEFORE

        public static final LabelingPlacement LINE_BELOW_BEFORE
        Upper right corner of label is at first geometry coord, label extrapolates the first geometry segment.
        Since:
        100.0.0
      • LINE_BELOW_END

        public static final LabelingPlacement LINE_BELOW_END
        Upper right corner of label is at final geometry coord, label follows the last geometry segments.
        Since:
        100.0.0
      • LINE_BELOW_START

        public static final LabelingPlacement LINE_BELOW_START
        Upper left corner of label is at first geometry coord, label follows the first geometry segments.
        Since:
        100.0.0
      • LINE_CENTER_AFTER

        public static final LabelingPlacement LINE_CENTER_AFTER
        Left midpoint of label is at final geometry coord, label extrapolates the last geometry segment.
        Since:
        100.0.0
      • LINE_CENTER_ALONG

        public static final LabelingPlacement LINE_CENTER_ALONG
        Center of label prefers the midpoint of the geometry, label follows the geometry segments.
        Since:
        100.0.0
      • LINE_CENTER_BEFORE

        public static final LabelingPlacement LINE_CENTER_BEFORE
        Right midpoint of label is at first geometry coord, label extrapolates the first geometry segment.
        Since:
        100.0.0
      • LINE_CENTER_END

        public static final LabelingPlacement LINE_CENTER_END
        Right midpoint of label is at final geometry coord, label follows the last geometry segments.
        Since:
        100.0.0
      • LINE_CENTER_START

        public static final LabelingPlacement LINE_CENTER_START
        Left midpoint of label is at first geometry coord, label follows the first geometry segments.
        Since:
        100.0.0
      • POINT_ABOVE_CENTER

        public static final LabelingPlacement POINT_ABOVE_CENTER
        Lower midpoint of label is offset north of point symbol.
        Since:
        100.0.0
      • POINT_ABOVE_LEFT

        public static final LabelingPlacement POINT_ABOVE_LEFT
        Lower right corner of the label is offset northwest of point symbol.
        Since:
        100.0.0
      • POINT_ABOVE_RIGHT

        public static final LabelingPlacement POINT_ABOVE_RIGHT
        Lower left corner of the label is offset northeast of point symbol.
        Since:
        100.0.0
      • POINT_BELOW_CENTER

        public static final LabelingPlacement POINT_BELOW_CENTER
        Upper midpoint of label is offset south of point symbol.
        Since:
        100.0.0
      • POINT_BELOW_LEFT

        public static final LabelingPlacement POINT_BELOW_LEFT
        Upper right corner of the label is offset southwest of point symbol.
        Since:
        100.0.0
      • POINT_BELOW_RIGHT

        public static final LabelingPlacement POINT_BELOW_RIGHT
        Upper left corner of the label is offset South-east of point symbol.
        Since:
        100.0.0
      • POINT_CENTER_CENTER

        public static final LabelingPlacement POINT_CENTER_CENTER
        Center of label is placed on geometry point.
        Since:
        100.0.0
      • POINT_CENTER_LEFT

        public static final LabelingPlacement POINT_CENTER_LEFT
        Right midpoint of label is offset West of point symbol.
        Since:
        100.0.0
      • POINT_CENTER_RIGHT

        public static final LabelingPlacement POINT_CENTER_RIGHT
        Left midpoint of label is offset East of point symbol.
        Since:
        100.0.0
      • POLYGON_ALWAYS_HORIZONTAL

        public static final LabelingPlacement POLYGON_ALWAYS_HORIZONTAL
        Center of label is as far inside polygon as possible.
        Since:
        100.0.0
    • Method Detail

      • values

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

        public static LabelingPlacement 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