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

applyEdit

param operation:

boundingBox

rtype:

QgsRectangle

clone

rtype:

QgsAnnotationPolygonItem

copyCommonProperties

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

create

Creates a new polygon 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 polygon 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) → QgsAnnotationPolygonItem
Return type:

QgsAnnotationPolygonItem

copyCommonProperties(self, other: QgsAnnotationItem)

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

New in version 3.22.

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

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: 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

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