Class: QgsAnnotationManager¶

Manages storage of a set of QgsAnnotation annotation objects.

QgsAnnotationManager handles the storage, serializing and deserializing of QgsAnnotations. Usually this class is not constructed directly, but rather accessed through a QgsProject via QgsProject.annotationManager().

QgsAnnotationManager retains ownership of all the annotations contained in the manager.

Class Hierarchy¶

Base classes¶

QObject

Methods

`accept`	Accepts the specified style entity visitor, causing it to visit all style entities associated within the contained annotations.
`addAnnotation`	Adds an annotation to the manager.
`annotations`	Returns a list of all annotations contained in the manager.
`clear`	Removes and deletes all annotations from the manager.
`cloneAnnotations`	Returns a list containing clones of all annotations contained in the manager.
`readXml`	Reads the manager's state from a DOM element, restoring all annotations present in the XML document.
`removeAnnotation`	Removes an annotation from the manager.
`writeXml`	Returns a DOM element representing the state of the manager.

Signals

`annotationAboutToBeRemoved`	Emitted when an annotation is about to be removed from the manager
`annotationAdded`	Emitted when a annotation has been added to the manager
`annotationRemoved`	Emitted when an annotation was removed from the manager

class qgis.core.QgsAnnotationManager[source]¶

Bases: QObject

__init__(project: QgsProject | None = None)

Constructor for QgsAnnotationManager. The project will become the parent object for this manager.

Parameters:: project (Optional[QgsProject] = None)

accept(self, visitor: QgsStyleEntityVisitorInterface | None) → bool[source]¶

Accepts the specified style entity visitor, causing it to visit all style entities associated within the contained annotations.

Returns True if the visitor should continue visiting other objects, or False if visiting should be canceled.

Added in version 3.10.

Parameters:: visitor (Optional[QgsStyleEntityVisitorInterface])
Return type:: bool

addAnnotation(self, annotation: QgsAnnotation | None) → bool[source]¶

Adds an annotation to the manager. Ownership of the annotation is transferred to the manager. Returns True if the addition was successful, or False if the annotation could not be added.

See also

removeAnnotation()

See also

annotationAdded()

Parameters:: annotation (Optional[QgsAnnotation])
Return type:: bool

signal annotationAboutToBeRemoved(annotation: QgsAnnotation)[source]¶

Emitted when an annotation is about to be removed from the manager

Parameters:: annotation (QgsAnnotation)

signal annotationAdded(annotation: QgsAnnotation)[source]¶

Emitted when a annotation has been added to the manager

Parameters:: annotation (QgsAnnotation)

signal annotationRemoved[source]¶: Emitted when an annotation was removed from the manager

annotations(self) → List[QgsAnnotation]¶

Returns a list of all annotations contained in the manager.

See also

cloneAnnotations()

Return type:: List[QgsAnnotation]

clear(self)[source]¶: Removes and deletes all annotations from the manager.

See also

removeAnnotation()

cloneAnnotations(self) → List[QgsAnnotation]¶

Returns a list containing clones of all annotations contained in the manager. The caller takes responsibility for deleting all returned annotations.

See also

annotations()

Return type:: List[QgsAnnotation]

readXml(self, element: QDomElement, context: QgsReadWriteContext) → bool[source]¶

Reads the manager’s state from a DOM element, restoring all annotations present in the XML document.

See also

writeXml()

Parameters:

element (QDomElement)
context (QgsReadWriteContext)

Return type:

bool

removeAnnotation(self, annotation: QgsAnnotation | None) → bool[source]¶

Removes an annotation from the manager. The annotation is deleted. Returns True if the removal was successful, or False if the removal failed (eg as a result of removing an annotation which is not contained in the manager).

See also

addAnnotation()

See also

annotationRemoved()

See also

annotationAboutToBeRemoved()

See also

clear()