Class: QgsAnnotationLineItem

class qgis.core.QgsAnnotationLineItem

Bases: QgsAnnotationItem

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

New in version 3.16.

QgsAnnotationLineItem(curve: QgsCurve) Constructor for QgsAnnotationLineItem, with the specified linestring.

Methods

applyEdit

param operation

boundingBox

rtype

QgsRectangle

clone

rtype

QgsAnnotationLineItem

copyCommonProperties

Copies common properties from the base class from an other item.

create

Creates a new linestring annotation item.

geometry

Returns the geometry of the item.

nodes

rtype

List[QgsAnnotationItemNode]

readCommonProperties

Reads common properties from the base class from the given DOM element.

readXml

param element

render

param context

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.

transientEditResults

param operation

type

rtype

str

writeCommonProperties

Writes common properties from the base class into an XML element.

writeXml

param element

applyEdit(self, operation: QgsAbstractAnnotationItemEditOperation) Qgis.AnnotationItemEditOperationResult
Parameters

operation (QgsAbstractAnnotationItemEditOperation) –

Return type

Qgis.AnnotationItemEditOperationResult

boundingBox(self) QgsRectangle
Return type

QgsRectangle

clone(self) QgsAnnotationLineItem
Return type

QgsAnnotationLineItem

copyCommonProperties(self, other: QgsAnnotationItem)

Copies common properties from the base class from an other item.

New in version 3.22.

create() QgsAnnotationLineItem

Creates a new linestring annotation item.

Return type

QgsAnnotationLineItem

geometry(self) QgsCurve

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

QgsCurve

nodes(self) List[QgsAnnotationItemNode]
Return type

List[QgsAnnotationItemNode]

readCommonProperties(self, element: QDomElement, context: QgsReadWriteContext) bool

Reads common properties from the base class from the given DOM element.

See also

readXml()

New in version 3.22.

readXml(self, element: QDomElement, context: QgsReadWriteContext) bool
Parameters
Return type

bool

render(self, context: QgsRenderContext, feedback: QgsFeedback)
Parameters
setGeometry(self, geometry: QgsCurve)

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 (QgsCurve) –

setSymbol(self, symbol: QgsLineSymbol)

Sets the symbol used to render the marker item.

The item takes ownership of the symbol.

See also

symbol()

Parameters

symbol (QgsLineSymbol) –

symbol(self) QgsLineSymbol

Returns the symbol used to render the item.

See also

setSymbol()

Return type

QgsLineSymbol

transientEditResults(self, operation: QgsAbstractAnnotationItemEditOperation) QgsAnnotationItemEditOperationTransientResults
Parameters

operation (QgsAbstractAnnotationItemEditOperation) –

Return type

QgsAnnotationItemEditOperationTransientResults

type(self) str
Return type

str

writeCommonProperties(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) bool

Writes common properties from the base class into an XML element.

See also

writeXml()

New in version 3.22.

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

bool