Class: QgsAnnotationPointTextItem

An annotation item which renders a text string at a point location.

Added in version 3.16.

Class Hierarchy

Base classes

QgsAnnotationItem

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

class qgis.core.QgsAnnotationPointTextItem

Bases: QgsAnnotationItem

__init__(text: str | None, point: QgsPointXY)

Constructor for QgsAnnotationPointTextItem, containing the specified text at the specified point.

Parameters:

• text (Optional[str])

• point (QgsPointXY)

alignment(self) → Qt.Alignment

Returns the text’s alignment relative to the reference point().

See also

setAlignment()

Return type:

Qt.Alignment

angle(self) → float

Returns the text’s rotation angle, in degrees clockwise.

See also

setAngle()

Return type:

float

static create() → QgsAnnotationPointTextItem | None

Creates a new text at point annotation item.

Return type:

Optional[QgsAnnotationPointTextItem]

format(self) → QgsTextFormat

Returns the text format used to render the text.

See also

setFormat()

Return type:

QgsTextFormat

point(self) → QgsPointXY

Returns the point location of the text.

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

See also

setPoint()

Return type:

QgsPointXY

rotationMode(self) → Qgis.SymbolRotationMode

Returns the rotation mode for the text item.

See also

setRotationMode()

Added in version 3.32.

Return type:

Qgis.SymbolRotationMode

setAlignment(self, alignment: Qt.Alignment | Qt.AlignmentFlag)

Sets the text’s alignment relative to the reference point().

See also

alignment()

Parameters:

alignment (Union[Qt.Alignment, Qt.AlignmentFlag])

setAngle(self, angle: float)

Sets the text’s rotation angle, in degrees clockwise.

See also

angle()

Parameters:

angle (float)

setFormat(self, format: QgsTextFormat)

Sets the text format used to render the text.

See also

format()

Parameters:

format (QgsTextFormat)

setPoint(self, point: QgsPointXY)

Sets the point location of the text.

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

See also

point()

Parameters:

point (QgsPointXY)

setRotationMode(self, mode: Qgis.SymbolRotationMode)

Sets the rotation mode for the text item.

See also

rotationMode()

Added in version 3.32.

Parameters:

mode (Qgis.SymbolRotationMode)

setText(self, text: str | None)

Sets the text rendered by the item.

See also

text()

Parameters:

text (Optional[str])

text(self) → str

Returns the text rendered by the item.

See also

setText()

Return type:

str