Class: QgsAnnotationItemAbstractMetadata

class qgis.core.QgsAnnotationItemAbstractMetadata(type: str, visibleName: str, visiblePluralName: str = '')

Bases: sip.wrapper

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.

QgsAnnotationItemAbstractMetadata(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.

New in version 3.16.

Parameters

  • type (str) –

  • visibleName (str) –

  • visiblePluralName –

createItem(self) → QgsAnnotationItem

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

Return type

QgsAnnotationItem

type(self) → str

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

Return type

str

visibleName(self) → str

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

See also

visiblePluralName()

Return type

str

visiblePluralName(self) → str

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

Return type

str