Class: QgsLayoutItemPolyline

Layout item for node based polyline shapes.

Class Hierarchy

Base classes

QgsLayoutNodesItem	An abstract layout item that provides generic methods for node based shapes such as polygon or polylines.
QgsLayoutItem	Base class for graphical items within a QgsLayout.
QgsLayoutObject	A base class for objects which belong to a layout.
QObject
QgsExpressionContextGenerator	Abstract interface for generating an expression context.
QGraphicsRectItem
QAbstractGraphicsShapeItem
QGraphicsItem
QgsLayoutUndoObjectInterface	Interface for layout objects which support undo/redo commands.

Methods

arrowHeadFillColor	Returns the color used to fill the arrow head.
arrowHeadStrokeColor	Returns the color used to draw the stroke around the the arrow head.
arrowHeadStrokeWidth	Returns the pen width in millimeters for the stroke of the arrow head.
arrowHeadWidth	Returns the width of line arrow heads in mm.
endMarker	Returns the end marker mode, which controls what marker is drawn at the end of the line.
endSvgMarkerPath	Returns the path the an SVG marker drawn at the end of the line.
setArrowHeadFillColor	Sets the color used to fill the arrow head.
setArrowHeadStrokeColor	Sets the color used to draw the stroke around the arrow head.
setArrowHeadStrokeWidth	Sets the pen width in millimeters for the stroke of the arrow head
setArrowHeadWidth	Sets the width of line arrow heads in mm.
setEndMarker	Sets the end marker mode, which controls what marker is drawn at the end of the line.
setEndSvgMarkerPath	Sets the path to a SVG marker to draw at the end of the line.
setStartMarker	Sets the start marker mode, which controls what marker is drawn at the start of the line.
setStartSvgMarkerPath	Sets the path to a SVG marker to draw at the start of the line.
setSymbol	Sets the symbol used to draw the shape.
startMarker	Returns the start marker mode, which controls what marker is drawn at the start of the line.
startSvgMarkerPath	Returns the path the an SVG marker drawn at the start of the line.
symbol	Returns the line symbol used to draw the shape.

Static Methods

create

Returns a new polyline item for the specified layout.

Attributes

ArrowHead
NoMarker
SvgMarker

class qgis.core.QgsLayoutItemPolyline

Bases: QgsLayoutNodesItem

__init__(layout: QgsLayout | None)

Constructor for QgsLayoutItemPolyline for the specified layout.

Parameters:

layout (Optional[QgsLayout])

__init__(polyline: QPolygonF, layout: QgsLayout | None)

Constructor for QgsLayoutItemPolyline for the specified polyline and layout.

Parameters:

• polyline (QPolygonF)

• layout (Optional[QgsLayout])

ArrowHead = 1

class MarkerMode

Bases: int

NoMarker = 0

SvgMarker = 2

arrowHeadFillColor(self) → QColor

Returns the color used to fill the arrow head.

See also

arrowHeadStrokeColor()

See also

setArrowHeadFillColor()

Return type:

QColor

arrowHeadStrokeColor(self) → QColor

Returns the color used to draw the stroke around the the arrow head.

See also

arrowHeadFillColor()

See also

setArrowHeadStrokeColor()

Return type:

QColor

arrowHeadStrokeWidth(self) → float

Returns the pen width in millimeters for the stroke of the arrow head.

See also

setArrowHeadStrokeWidth()

See also

arrowHeadStrokeColor()

Return type:

float

arrowHeadWidth(self) → float

Returns the width of line arrow heads in mm.

See also

setArrowHeadWidth()

Return type:

float

static create(layout: QgsLayout | None) → QgsLayoutItemPolyline | None

Returns a new polyline item for the specified layout.

The caller takes responsibility for deleting the returned object.

Parameters:

layout (Optional[QgsLayout])

Return type:

Optional[QgsLayoutItemPolyline]

endMarker(self) → QgsLayoutItemPolyline.MarkerMode

Returns the end marker mode, which controls what marker is drawn at the end of the line.

See also

setEndMarker()

See also

startMarker()

Return type:

QgsLayoutItemPolyline.MarkerMode

endSvgMarkerPath(self) → str

Returns the path the an SVG marker drawn at the end of the line.

See also

setEndSvgMarkerPath()

See also

startSvgMarkerPath()

Return type:

str

setArrowHeadFillColor(self, color: QColor | Qt.GlobalColor)

Sets the color used to fill the arrow head.

See also

arrowHeadFillColor()

See also

setArrowHeadStrokeColor()

Parameters:

color (Union[QColor, Qt.GlobalColor])

setArrowHeadStrokeColor(self, color: QColor | Qt.GlobalColor)

Sets the color used to draw the stroke around the arrow head.

See also

setArrowHeadFillColor()

See also

arrowHeadStrokeColor()

Parameters:

color (Union[QColor, Qt.GlobalColor])

setArrowHeadStrokeWidth(self, width: float)

Sets the pen width in millimeters for the stroke of the arrow head

See also

arrowHeadStrokeWidth()

See also

setArrowHeadStrokeColor()

Parameters:

width (float)

setArrowHeadWidth(self, width: float)

Sets the width of line arrow heads in mm.

See also

arrowHeadWidth()

Parameters:

width (float)

setEndMarker(self, mode: QgsLayoutItemPolyline.MarkerMode)

Sets the end marker mode, which controls what marker is drawn at the end of the line.

See also

endMarker()

See also

setStartMarker()

Parameters:

mode (QgsLayoutItemPolyline.MarkerMode)

setEndSvgMarkerPath(self, path: str | None)

Sets the path to a SVG marker to draw at the end of the line.

See also

endSvgMarkerPath()

See also

setStartSvgMarkerPath()

Parameters:

path (Optional[str])

setStartMarker(self, mode: QgsLayoutItemPolyline.MarkerMode)

Sets the start marker mode, which controls what marker is drawn at the start of the line.

See also

startMarker()

See also

setEndMarker()

Parameters:

mode (QgsLayoutItemPolyline.MarkerMode)

setStartSvgMarkerPath(self, path: str | None)

Sets the path to a SVG marker to draw at the start of the line.

See also

startSvgMarkerPath()

See also

setEndSvgMarkerPath()

Parameters:

path (Optional[str])

setSymbol(self, symbol: QgsLineSymbol | None)

Sets the symbol used to draw the shape. Ownership of symbol is not transferred.

See also

symbol()

Parameters:

symbol (Optional[QgsLineSymbol])

startMarker(self) → QgsLayoutItemPolyline.MarkerMode

Returns the start marker mode, which controls what marker is drawn at the start of the line.

See also

setStartMarker()

See also

endMarker()

Return type:

QgsLayoutItemPolyline.MarkerMode

startSvgMarkerPath(self) → str

Returns the path the an SVG marker drawn at the start of the line.

See also

setStartSvgMarkerPath()

See also

endSvgMarkerPath()

Return type:

str

symbol(self) → QgsLineSymbol | None

Returns the line symbol used to draw the shape.

See also

setSymbol()

Return type:

Optional[QgsLineSymbol]