Class: QgsAnnotationItemAbstractMetadata

Stores metadata about one annotation item class.

A companion class, QgsAnnotationItemAbstractGuiMetadata, handles the GUI behavior of QgsAnnotationItems.

Note

In C++ you can use QgsAnnotationItemMetadata convenience class.

Added in version 3.16.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: createItem()

Abstract Methods

createItem

Creates a new, default, annotation item of this class.

Methods

type

Returns the unique item type string for the annotation item class.

visibleName

Returns a translated, user visible name for the annotation item class.

visiblePluralName

Returns a translated, user visible name for plurals of the annotation item class (e.g. "Labels" for a "Label" item).
class qgis.core.QgsAnnotationItemAbstractMetadata[source]

Bases: object

__init__(type: str | None, visibleName: str | None, visiblePluralName: str | None = '')

Constructor for QgsAnnotationItemAbstractMetadata with the specified class type and visibleName.

The optional visiblePluralName argument can be used to specify a plural variant of the item type.

Parameters:

  • type (Optional[str])

  • visibleName (Optional[str])

  • visiblePluralName (Optional[str] = '')

__init__(a0: QgsAnnotationItemAbstractMetadata)
Parameters:

a0 (QgsAnnotationItemAbstractMetadata)

abstract createItem(self) → QgsAnnotationItem | None[source]

Creates a new, default, annotation item of this class.

Return type:

Optional[QgsAnnotationItem]

type(self) → str[source]

Returns the unique item type string for the annotation item class.

Return type:

str

visibleName(self) → str[source]

Returns a translated, user visible name for the annotation item class.

See also

visiblePluralName()

Return type:

str

visiblePluralName(self) → str[source]

Returns a translated, user visible name for plurals of the annotation item class (e.g. “Labels” for a “Label” item).

Return type:

str