Class: QgsLayoutItemPolyline

class qgis.core.QgsLayoutItemPolyline

Bases: QgsLayoutNodesItem

Layout item for node based polyline shapes.

New in version 3.0.

QgsLayoutItemPolyline(layout: QgsLayout) Constructor for QgsLayoutItemPolyline for the specified layout.

QgsLayoutItemPolyline(polyline: QPolygonF, layout: QgsLayout) Constructor for QgsLayoutItemPolyline for the specified polyline and layout.

Methods

accept

param visitor

adjustPointForReferencePosition

Adjusts the specified point at which a reference position of the item sits and returns the top left corner of the item, if reference point were placed at the specified position.

applyDataDefinedSize

Applies any present data defined size overrides to the specified layout size.

applyItemSizeConstraint

Applies any item-specific size constraint handling to a given targetSize in layout units.

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.

childEvent

computeDistance

Compute an euclidean distance between 2 nodes.

connectNotify

contextMenuEvent

create

Returns a new polyline item for the specified layout.

customEvent

disconnectNotify

displayName

rtype

str

dragEnterEvent

dragLeaveEvent

dragMoveEvent

draw

drawBackground

Draws the background for the item.

drawDebugRect

Draws a debugging rectangle of the item’s current bounds within the specified painter.

drawFrame

Draws the frame around the item.

dropEvent

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.

focusInEvent

focusOutEvent

framePath

Returns the path to use when drawing the item’s frame or background.

hoverEnterEvent

hoverLeaveEvent

hoverMoveEvent

icon

rtype

QIcon

inputMethodEvent

inputMethodQuery

isSignalConnected

itemChange

keyPressEvent

keyReleaseEvent

mouseDoubleClickEvent

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

positionAtReferencePoint

Returns the current position (in layout units) of a reference point for the item.

prepareGeometryChange

readObjectPropertiesFromElement

Sets object properties from a DOM element

readPropertiesFromElement

param element

receivers

refreshBackgroundColor

Refresh item’s background color, considering data defined colors.

refreshBlendMode

Refresh item’s blend mode, considering data defined blend mode.

refreshFrame

Refresh item’s frame, considering data defined colors and frame size.

refreshItemPosition

Refreshes an item’s position by rechecking it against any possible overrides such as data defined positioning.

refreshItemRotation

Refreshes an item’s rotation by rechecking it against any possible overrides such as data defined rotation.

refreshItemSize

Refreshes an item’s size by rechecking it against any possible item fixed or minimum sizes.

refreshOpacity

Refresh item’s opacity, considering data defined opacity.

rescaleToFitBoundingBox

Rescale the current shape according to the item’s bounding box.

sceneEvent

sceneEventFilter

sender

senderSignalIndex

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.

setFixedSize

Sets a fixed size for the layout item, which prevents it from being freely resized.

setMinimumSize

Sets the minimum allowed size for the layout item.

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.

shape

rtype

QPainterPath

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.

timerEvent

topLeftToReferencePoint

Returns the position for the reference point of the item, if the top-left of the item was placed at the specified point.

type

rtype

int

updateBoundingRect

updateMicroFocus

updateSceneRect

Update the current scene rectangle for this item.

wheelEvent

writeObjectPropertiesToElement

Stores object properties within an XML DOM element.

writePropertiesToElement

param element

Attributes

ArrowHead

NoMarker

SvgMarker

ArrowHead = 1
class MarkerMode

Bases: int

NoMarker = 0
SvgMarker = 2
accept(self, visitor: QgsStyleEntityVisitorInterface)bool
Parameters

visitor (QgsStyleEntityVisitorInterface) –

Return type

bool

adjustPointForReferencePosition(self, point: Union[QPointF, QPoint], size: QSizeF, reference: QgsLayoutItem.ReferencePoint)QPointF

Adjusts the specified point at which a reference position of the item sits and returns the top left corner of the item, if reference point were placed at the specified position.

applyDataDefinedSize(self, size: QgsLayoutSize)QgsLayoutSize

Applies any present data defined size overrides to the specified layout size.

applyItemSizeConstraint(self, targetSize: QSizeF)QSizeF

Applies any item-specific size constraint handling to a given targetSize in layout units. Subclasses can override this method if they need to apply advanced logic regarding item sizes, which cannot be covered by setFixedSize() or setMinimumSize(). Item size constraints are applied after fixed, minimum and data defined size constraints.

See also

setFixedSize()

See also

setMinimumSize()

arrowHeadFillColor(self)QColor

Returns the color used to fill the arrow head.

Return type

QColor

arrowHeadStrokeColor(self)QColor

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

Return type

QColor

arrowHeadStrokeWidth(self)float

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

Return type

float

arrowHeadWidth(self)float

Returns the width of line arrow heads in mm.

Return type

float

childEvent(self, QChildEvent)
computeDistance(self, pt1: Union[QPointF, QPoint], pt2: Union[QPointF, QPoint])float

Compute an euclidean distance between 2 nodes.

connectNotify(self, QMetaMethod)
contextMenuEvent(self, QGraphicsSceneContextMenuEvent)
create(layout: QgsLayout)QgsLayoutItemPolyline

Returns a new polyline item for the specified layout.

The caller takes responsibility for deleting the returned object.

Parameters

layout (QgsLayout) –

Return type

QgsLayoutItemPolyline

customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
displayName(self)str
Return type

str

dragEnterEvent(self, QGraphicsSceneDragDropEvent)
dragLeaveEvent(self, QGraphicsSceneDragDropEvent)
dragMoveEvent(self, QGraphicsSceneDragDropEvent)
draw(self, context: QgsLayoutItemRenderContext)
drawBackground(self, context: QgsRenderContext)

Draws the background for the item.

See also

framePath()

drawDebugRect(self, painter: QPainter)

Draws a debugging rectangle of the item’s current bounds within the specified painter.

Parameters

painter – destination QPainter

drawFrame(self, context: QgsRenderContext)

Draws the frame around the item.

See also

framePath()

dropEvent(self, QGraphicsSceneDragDropEvent)
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.

Return type

str

focusInEvent(self, QFocusEvent)
focusOutEvent(self, QFocusEvent)
framePath(self)QPainterPath

Returns the path to use when drawing the item’s frame or background.

See also

drawFrame()

See also

drawBackground()

New in version 3.16.

hoverEnterEvent(self, QGraphicsSceneHoverEvent)
hoverLeaveEvent(self, QGraphicsSceneHoverEvent)
hoverMoveEvent(self, QGraphicsSceneHoverEvent)
icon(self)QIcon
Return type

QIcon

inputMethodEvent(self, QInputMethodEvent)
inputMethodQuery(self, Qt.InputMethodQuery)Any
isSignalConnected(self, QMetaMethod)bool
itemChange(self, QGraphicsItem.GraphicsItemChange, Any)Any
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
mouseDoubleClickEvent(self, QGraphicsSceneMouseEvent)
mouseMoveEvent(self, QGraphicsSceneMouseEvent)
mousePressEvent(self, QGraphicsSceneMouseEvent)
mouseReleaseEvent(self, QGraphicsSceneMouseEvent)
positionAtReferencePoint(self, reference: QgsLayoutItem.ReferencePoint)QPointF

Returns the current position (in layout units) of a reference point for the item.

prepareGeometryChange(self)
readObjectPropertiesFromElement(self, parentElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext)bool

Sets object properties from a DOM element

Parameters
  • parentElement – is the parent DOM element for the object

  • document – DOM document

  • context – read write context

Returns

True if read was successful

readPropertiesFromElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext)bool
Parameters
Return type

bool

receivers(self, PYQT_SIGNAL)int
refreshBackgroundColor(self, updateItem: bool = True)

Refresh item’s background color, considering data defined colors. If updateItem is set to False, the item will not be automatically updated after the frame color is set and a later call to update() must be made.

refreshBlendMode(self)

Refresh item’s blend mode, considering data defined blend mode.

refreshFrame(self, updateItem: bool = True)

Refresh item’s frame, considering data defined colors and frame size. If updateItem is set to False, the item will not be automatically updated after the frame is set and a later call to update() must be made.

refreshItemPosition(self)

Refreshes an item’s position by rechecking it against any possible overrides such as data defined positioning.

refreshItemRotation(self, origin: Union[QPointF, QPoint] = None)

Refreshes an item’s rotation by rechecking it against any possible overrides such as data defined rotation.

The optional origin point specifies the origin (in item coordinates) around which the rotation should be applied.

refreshItemSize(self)

Refreshes an item’s size by rechecking it against any possible item fixed or minimum sizes.

See also

setFixedSize()

See also

setMinimumSize()

refreshOpacity(self, updateItem: bool = True)

Refresh item’s opacity, considering data defined opacity. If updateItem is set to False the item will not be automatically updated after the opacity is set and a later call to update() must be made.

rescaleToFitBoundingBox(self)

Rescale the current shape according to the item’s bounding box. Useful when the shape is resized thanks to the rubber band.

sceneEvent(self, QEvent)bool
sceneEventFilter(self, QGraphicsItem, QEvent)bool
sender(self)QObject
senderSignalIndex(self)int
setArrowHeadFillColor(self, color: Union[QColor, Qt.GlobalColor, QGradient])

Sets the color used to fill the arrow head.

Parameters

color (Union[QColor) –

setArrowHeadStrokeColor(self, color: Union[QColor, Qt.GlobalColor, QGradient])

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

Parameters

color (Union[QColor) –

setArrowHeadStrokeWidth(self, width: float)

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

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)

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

Parameters

path (str) –

setFixedSize(self, size: QgsLayoutSize)

Sets a fixed size for the layout item, which prevents it from being freely resized. Set an empty size if item can be freely resized.

See also

fixedSize()

See also

setMinimumSize()

setMinimumSize(self, size: QgsLayoutSize)

Sets the minimum allowed size for the layout item. Set an empty size if item can be freely resized.

See also

minimumSize()

See also

setFixedSize()

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)

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

Parameters

path (str) –

setSymbol(self, symbol: QgsLineSymbol)

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

See also

symbol()

Parameters

symbol (QgsLineSymbol) –

shape(self)QPainterPath
Return type

QPainterPath

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.

Return type

str

symbol(self)QgsLineSymbol

Returns the line symbol used to draw the shape.

See also

setSymbol()

Return type

QgsLineSymbol

timerEvent(self, QTimerEvent)
topLeftToReferencePoint(self, point: QgsLayoutPoint)QgsLayoutPoint

Returns the position for the reference point of the item, if the top-left of the item was placed at the specified point.

type(self)int
Return type

int

updateBoundingRect(self)
updateMicroFocus(self)
updateSceneRect(self)

Update the current scene rectangle for this item.

wheelEvent(self, QGraphicsSceneWheelEvent)
writeObjectPropertiesToElement(self, parentElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext)bool

Stores object properties within an XML DOM element.

Parameters
  • parentElement – is the parent DOM element to store the object’s properties in

  • document – DOM document

  • context – read write context

Returns

True if write was successful

writePropertiesToElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext)bool
Parameters
Return type

bool