Class: QgsAnnotationLineItem

An annotation item which renders a line symbol along a line geometry.

Added in version 3.16.

Class Hierarchy

Base classes

QgsAnnotationItem

Abstract base class for annotation items which are drawn with QgsAnnotationLayers.

Methods

geometry	Returns the geometry of the item.
setGeometry	Sets the geometry of the item.
setSymbol	Sets the symbol used to render the marker item.
symbol	Returns the symbol used to render the item.

Static Methods

create

Creates a new linestring annotation item.

class qgis.core.QgsAnnotationLineItem

Bases: QgsAnnotationItem

__init__(curve: QgsCurve | None)

Constructor for QgsAnnotationLineItem, with the specified curve.

Parameters:

curve (Optional[QgsCurve])

static create() → QgsAnnotationLineItem | None

Creates a new linestring annotation item.

Return type:

Optional[QgsAnnotationLineItem]

geometry(self) → QgsCurve | None

Returns the geometry of the item.

The coordinate reference system for the line will be the parent layer’s QgsAnnotationLayer.crs().

See also

setGeometry()

Return type:

Optional[QgsCurve]

setGeometry(self, geometry: QgsCurve | None)

Sets the geometry of the item. Ownership of geometry is transferred.

The coordinate reference system for the line will be the parent layer’s QgsAnnotationLayer.crs().

See also

geometry()

Parameters:

geometry (Optional[QgsCurve])

setSymbol(self, symbol: QgsLineSymbol | None)

Sets the symbol used to render the marker item.

The item takes ownership of the symbol.

See also

symbol()

Parameters:

symbol (Optional[QgsLineSymbol])

symbol(self) → QgsLineSymbol | None

Returns the symbol used to render the item.

See also

setSymbol()

Return type:

Optional[QgsLineSymbol]