org.opengis.style

Interface LinePlacement

All Superinterfaces:

LabelPlacement

All Known Subinterfaces:

LinePlacement

All Known Implementing Classes:

LinePlacementImpl

@XmlElement(value="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

Author:

Open Geospatial Consortium, Johann Sorel (Geomatys), Ian Turton, CCG

Method Summary

Modifier and Type	Method and 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(value="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.

Returns:

Expression

getInitialGap

@XmlElement(value="InitialGap")
Expression getInitialGap()

InitialGap specifies how far away the first graphic will be drawn relative to the start of the rendering line

Returns:

Expression

getGap

@XmlElement(value="Gap")
Expression getGap()

Gap gives the distance between two graphics.

Returns:

Expression

isRepeated

@XmlElement(value="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

@XmlElement(value="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

@XmlElement(value="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.

Returns:

boolean

accept

@Extension
Object accept(StyleVisitor visitor,
                         Object extraData)

calls the visit method of a StyleVisitor

Specified by:

accept in interface LabelPlacement

Parameters:

visitor - the style visitor