Class: QgsAnnotationPolygonItem

An annotation item which renders a fill symbol for a polygon 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 polygon item.
symbol	Returns the symbol used to render the item.

Static Methods

create

Creates a new polygon annotation item.

class qgis.core.QgsAnnotationPolygonItem

Bases: QgsAnnotationItem

__init__(polygon: QgsCurvePolygon | None)

Constructor for QgsAnnotationPolygonItem, with the specified polygon geometry.

Parameters:

polygon (Optional[QgsCurvePolygon])

static create() → QgsAnnotationPolygonItem | None

Creates a new polygon annotation item.

Return type:

Optional[QgsAnnotationPolygonItem]

geometry(self) → QgsCurvePolygon | None

Returns the geometry of the item.

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

See also

setGeometry()

Return type:

Optional[QgsCurvePolygon]

setGeometry(self, geometry: QgsCurvePolygon | None)

Sets the geometry of the item.

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

See also

geometry()

Parameters:

geometry (Optional[QgsCurvePolygon])

setSymbol(self, symbol: QgsFillSymbol | None)

Sets the symbol used to render the polygon item.

The item takes ownership of the symbol.

See also

symbol()

Parameters:

symbol (Optional[QgsFillSymbol])

symbol(self) → QgsFillSymbol | None

Returns the symbol used to render the item.

See also

setSymbol()

Return type:

Optional[QgsFillSymbol]