Class: QgsAnnotationRectangleTextItem

An annotation item which renders paragraphs of text within a rectangle.

Added in version 3.40.

Class Hierarchy

Base classes

QgsAnnotationRectItem	Abstract base class for annotation items which render annotations in a rectangular shape.
QgsAnnotationItem	Abstract base class for annotation items which are drawn with QgsAnnotationLayers.

class qgis.core.QgsAnnotationRectangleTextItem

Bases: QgsAnnotationRectItem

__init__(text: str | None, bounds: QgsRectangle)

Constructor for QgsAnnotationRectangleTextItem, containing the specified text within the specified bounds rectangle.

Parameters:

• text (Optional[str])

• bounds (QgsRectangle)

alignment(self) → Qt.Alignment

Returns the text’s alignment relative to the bounds() rectangle.

See also

setAlignment()

Return type:

Qt.Alignment

static create() → QgsAnnotationRectangleTextItem | None

Creates a new rectangle text annotation item.

Return type:

Optional[QgsAnnotationRectangleTextItem]

format(self) → QgsTextFormat

Returns the text format used to render the text.

See also

setFormat()

Return type:

QgsTextFormat

margins(self) → QgsMargins

Returns the margins between the outside of the item’s frame and the interior text.

Units are retrieved via marginsUnit()

See also

setMargins()

See also

marginsUnit()

Return type:

QgsMargins

marginsUnit(self) → Qgis.RenderUnit

Returns the units for the margins between the item’s frame and the interior text.

See also

setMarginsUnit()

See also

margins()

Return type:

Qgis.RenderUnit

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

Sets the text’s alignment relative to the bounds() rectangle.

See also

alignment()

Parameters:

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

setFormat(self, format: QgsTextFormat)

Sets the text format used to render the text.

See also

format()

Parameters:

format (QgsTextFormat)

setMargins(self, margins: QgsMargins)

Sets the margins between the outside of the item’s frame and the interior text.

Units are set via setMarginsUnit()

See also

margins()

See also

setMarginsUnit()

Parameters:

margins (QgsMargins)

setMarginsUnit(self, unit: Qgis.RenderUnit)

Sets the unit for the margins between the item’s frame and the interior text.

See also

margins()

See also

marginsUnit()

Parameters:

unit (Qgis.RenderUnit)

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