Package org.geotools.api.style

Interface LinePlacement

  • All Superinterfaces:
    LabelPlacement
    All Known Implementing Classes:
    LinePlacementImpl
    public interface LinePlacement
extends LabelPlacement
    The "LinePlacement" specifies where and how a text label should be rendered relative to a line.
    Since:
    GeoAPI 2.2
    Author:
    Open Geospatial Consortium, Johann Sorel (Geomatys), Ian Turton, CCG

    • Method Detail

      • getPerpendicularOffset

        Expression getPerpendicularOffset()
        The PerpendicularOffset element of a LinePlacement gives the perpendicular distance away from a line to draw a label.

        The distance is in uoms and is positive to the left-hand side of the line string. Negative numbers mean right. The default offset is 0.

        Returns:
        Expression

      • getInitialGap

        Expression getInitialGap()
        InitialGap specifies how far away the first graphic will be drawn relative to the start of the rendering line
        Returns:
        Expression

      • getGap

        Expression getGap()
        Gap gives the distance between two graphics.
        Returns:
        Expression

      • isRepeated

        boolean isRepeated()
        If IsRepeated is "true", the label will be repeatedly drawn along the line with InitialGap and Gap defining the spaces at the beginning and between labels.
        Returns:
        boolean

      • isAligned

        boolean isAligned()
        Labels can either be aligned to the line geometry if IsAligned is "true" (the default) or are drawn horizontally.
        Returns:
        boolean

      • isGeneralizeLine

        boolean isGeneralizeLine()
        GeneralizeLine allows the actual geometry, be it a linestring or polygon to be generalized for label placement. This is e.g. useful for labelling polygons inside their interior when there is need for the label to resemble the shape of the polygon.
        Returns:
        boolean

      • setPerpendicularOffset

        void setPerpendicularOffset​(Expression offset)
        Sets the expression that is used to compute how far from the lines the text will be drawn. See getPerpendicularOffset() for details.

      • setRepeated

        void setRepeated​(boolean repeated)

      • setGeneralized

        void setGeneralized​(boolean generalized)

      • setAligned

        void setAligned​(boolean aligned)

      • setInitialGap

        void setInitialGap​(Expression initialGap)