Class: QgsAnnotationPolygonItem

class qgis.core.QgsAnnotationPolygonItem

Bases: QgsAnnotationItem

An annotation item which renders a fill symbol for a polygon geometry.

New in version 3.16.

QgsAnnotationPolygonItem(polygon: QgsCurvePolygon) Constructor for QgsAnnotationPolygonItem, with the specified polygon geometry.

Methods

boundingBox

rtype

QgsRectangle

clone

rtype

QgsAnnotationPolygonItem

create

Creates a new polygon annotation item.

geometry

Returns the geometry of the item.

readXml

param element

render

param context

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.

type

rtype

str

writeXml

param element

boundingBox(self)QgsRectangle
Return type

QgsRectangle

clone(self)QgsAnnotationPolygonItem
Return type

QgsAnnotationPolygonItem

create()QgsAnnotationPolygonItem

Creates a new polygon annotation item.

Return type

QgsAnnotationPolygonItem

geometry(self)QgsCurvePolygon

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

QgsCurvePolygon

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

bool

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

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

setSymbol(self, symbol: QgsFillSymbol)

Sets the symbol used to render the polygon item.

The item takes ownership of the symbol.

See also

symbol()

Parameters

symbol (QgsFillSymbol) –

symbol(self)QgsFillSymbol

Returns the symbol used to render the item.

See also

setSymbol()

Return type

QgsFillSymbol

type(self)str
Return type

str

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

bool