Class: QgsLayoutItemAbstractMetadata¶
- class qgis.core.QgsLayoutItemAbstractMetadata(type: int, visibleName: str, visiblePluralName: str = '')¶
Bases:
sip.wrapper
Constructor for
QgsLayoutItemAbstractMetadata
with the specified classtype
andvisibleName
.The optional
visiblePluralName
argument can be used to specify a plural variant of the item type.QgsLayoutItemAbstractMetadata(
QgsLayoutItemAbstractMetadata
)Stores metadata about one layout item class.
A companion class,
QgsLayoutItemAbstractGuiMetadata
, handles the GUI behavior ofQgsLayoutItems
.Note
In C++ you can use
QgsLayoutItemMetadata
convenience class.Methods
Creates a layout item of this class for a specified
layout
.Resolve paths in the item’s
properties
(if there are any paths).Returns the unique item type code for the layout item class.
Returns a translated, user visible name for the layout item class.
Returns a translated, user visible name for plurals of the layout item class (e.g.
- createItem(self, layout: QgsLayout) → QgsLayoutItem¶
Creates a layout item of this class for a specified
layout
.- Parameters
layout (QgsLayout) –
- Return type
- resolvePaths(self, properties: Dict[str, Any], pathResolver: QgsPathResolver, saving: bool)¶
Resolve paths in the item’s
properties
(if there are any paths). Whensaving
isTrue
, paths are converted from absolute to relative, whensaving
isFalse
, paths are converted from relative to absolute. This ensures that paths in project files can be relative, but in item instances the paths are always absolute.- Parameters
properties (Dict[str) –
pathResolver (QgsPathResolver) –
saving (bool) –
- type(self) → int¶
Returns the unique item type code for the layout item class.
- Return type
int
- visibleName(self) → str¶
Returns a translated, user visible name for the layout item class.
See also
- Return type
str
- visiblePluralName(self) → str¶
Returns a translated, user visible name for plurals of the layout item class (e.g. “Labels” for a “Label” item).
New in version 3.10.
- Return type
str