Interface LinePlacement

  • All Superinterfaces:
    LabelPlacement

    @XmlElement("LinePlacement")
    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
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Object accept​(StyleVisitor visitor, Object extraData)
      calls the visit method of a StyleVisitor
      Expression getGap()
      Gap gives the distance between two graphics.
      Expression getInitialGap()
      InitialGap specifies how far away the first graphic will be drawn relative to the start of the rendering line
      Expression getPerpendicularOffset()
      The PerpendicularOffset element of a LinePlacement gives the perpendicular distance away from a line to draw a label.
      boolean IsAligned()
      Labels can either be aligned to the line geometry if IsAligned is "true" (the default) or are drawn horizontally.
      boolean isGeneralizeLine()
      GeneralizeLine allows the actual geometry, be it a linestring or polygon to be generalized for label placement.
      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.
    • Method Detail

      • getPerpendicularOffset

        @XmlElement("PerpendicularOffset")
        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.
      • getInitialGap

        @XmlElement("InitialGap")
        Expression getInitialGap()
        InitialGap specifies how far away the first graphic will be drawn relative to the start of the rendering line
      • isRepeated

        @XmlElement("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.
      • IsAligned

        @XmlElement("IsAligned")
        boolean IsAligned()
        Labels can either be aligned to the line geometry if IsAligned is "true" (the default) or are drawn horizontally.
      • isGeneralizeLine

        @XmlElement("GeneralizeLine")
        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.