Class: QgsAnnotationPolygonItem¶
- class qgis.core.QgsAnnotationPolygonItem¶
Bases:
QgsAnnotationItem
An annotation item which renders a fill symbol for a polygon geometry.
Added in version 3.16.
QgsAnnotationPolygonItem(polygon: Optional[QgsCurvePolygon]) Constructor for
QgsAnnotationPolygonItem
, with the specifiedpolygon
geometry.Methods
- param operation:
- rtype:
QgsRectangle
- rtype:
Optional[QgsAnnotationPolygonItem]
Copies common properties from the base class from an
other
item.Creates a new polygon annotation item.
Returns the geometry of the item.
- rtype:
List[QgsAnnotationItemNode]
Reads common properties from the base class from the given DOM
element
.- param element:
- param context:
Sets the
geometry
of the item.Sets the
symbol
used to render the polygon item.Returns the symbol used to render the item.
- param operation:
- rtype:
str
Writes common properties from the base class into an XML
element
.- param element:
- applyEdit(self, operation: QgsAbstractAnnotationItemEditOperation | None) Qgis.AnnotationItemEditOperationResult ¶
- Parameters:
operation (Optional[QgsAbstractAnnotationItemEditOperation])
- Return type:
- boundingBox(self) QgsRectangle ¶
- Return type:
- clone(self) QgsAnnotationPolygonItem | None ¶
- Return type:
Optional[QgsAnnotationPolygonItem]
- copyCommonProperties(self, other: QgsAnnotationItem | None)¶
Copies common properties from the base class from an
other
item.Added in version 3.22.
- 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
- Return type:
Optional[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
Added in version 3.22.
- readXml(self, element: QDomElement, context: QgsReadWriteContext) bool ¶
- Parameters:
element (QDomElement)
context (QgsReadWriteContext)
- Return type:
bool
- render(self, context: QgsRenderContext, feedback: QgsFeedback | None)¶
- Parameters:
context (QgsRenderContext)
feedback (Optional[QgsFeedback])
- 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
- 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
- Parameters:
symbol (Optional[QgsFillSymbol])
- symbol(self) QgsFillSymbol | None ¶
Returns the symbol used to render the item.
See also
- Return type:
Optional[QgsFillSymbol]
- transientEditResults(self, operation: QgsAbstractAnnotationItemEditOperation | None) QgsAnnotationItemEditOperationTransientResults | None ¶
- Parameters:
operation (Optional[QgsAbstractAnnotationItemEditOperation])
- Return type:
- 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
Added in version 3.22.
- writeXml(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) bool ¶
- Parameters:
element (QDomElement)
document (QDomDocument)
context (QgsReadWriteContext)
- Return type:
bool