Enum LabelTextLayout

    • Enum Constant Detail


        public static final LabelTextLayout AUTOMATIC
        The text layout will be determined by the individual feature type.

        For each label, the layout will be determined by the feature geometry type:


        public static final LabelTextLayout HORIZONTAL
        Text will be written horizontally (with respect to the screen).

        If the map is rotated within the screen, then the text will be redrawn (and possibly repositioned) to remain horizontal with respect to the screen.


        public static final LabelTextLayout PERPENDICULAR
        Text will be written perpendicular to the STRAIGHT text layout.
      • STRAIGHT

        public static final LabelTextLayout STRAIGHT
        Text will be written along a straight line, following the point positioning angle or at a tangent to the line feature.

        An angle for placement and orientation will be calculated for each label if the "labelAngleInfo" JSON property for the LabelDefinition has been specified.

        Centered point labels will stay centered on the point feature, but will be rotated to the angle (or horizontal, if none has been defined).

        Offset point labels will be positioned around the point feature, at the position specified by the angle. The text will lie along this angle, so that it stretches radially from the edge of the point feature.

        Note that if a label has an angle of zero then its text will be drawn horizontally with respect to the map. If the map is rotated within the screen, the text will rotate with the map.

        Line labels will be positioned as usual, but then rotated (around their midpoint) to lie on a straight line at a tangent to the line geometry at that point.


        public static final LabelTextLayout FOLLOW_FEATURE
        Text will bend to follow a curved or multi-segment line feature.

        Individual characters will be angled to follow the changes in angle of the line geometry. If the text overruns the beginning or end of the line geometry, then the remaining characters will be laid out in a straight line extrapolated from the last geometry segment.

    • Method Detail

      • values

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

        public static LabelTextLayout valueOf​(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.)
        name - the name of the enum constant to be returned.
        the enum constant with the specified name
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null