Class: QgsLayoutItemRegistry

class qgis.core.QgsLayoutItemRegistry

Bases: PyQt5.QtCore.QObject

Registry of available layout item types.

QgsLayoutItemRegistry is not usually directly created, but rather accessed through QgsApplication.layoutItemRegistry().

A companion class, QgsLayoutItemGuiRegistry, handles the GUI behavior of layout items.

New in version 3.0.

QgsLayoutItemRegistry(parent: QObject = None) Creates a new empty item registry.

QgsLayoutItemRegistry is not usually directly created, but rather accessed through QgsApplication.layoutItemRegistry().

See also

populate()

Methods

addLayoutItemType	Registers a new layout item type.
addLayoutMultiFrameType	Registers a new layout multiframe type.
childEvent
connectNotify
createItem	Creates a new instance of a layout item given the item type, and target layout.
createMultiFrame	Creates a new instance of a layout multiframe given the multiframe type, and target layout.
customEvent
disconnectNotify
isSignalConnected
itemMetadata	Returns the metadata for the specified item type.
itemTypes	Returns a map of available item types to translated name.
multiFrameMetadata	Returns the metadata for the specified multiframe type.
populate	Populates the registry with standard item types.
receivers
resolvePaths	Resolve paths in properties of a particular symbol layer.
sender
senderSignalIndex
timerEvent

Signals

multiFrameTypeAdded	pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
typeAdded	pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

Attributes

Layout3DMap
LayoutAttributeTable
LayoutElevationProfile
LayoutFrame
LayoutGroup
LayoutHtml
LayoutItem
LayoutLabel
LayoutLegend
LayoutManualTable
LayoutMap
LayoutMarker
LayoutPage
LayoutPicture
LayoutPolygon
LayoutPolyline
LayoutScaleBar
LayoutShape
LayoutTextTable
PluginItem

class ItemType

Bases: int

Layout3DMap = 65651

LayoutAttributeTable = 65649

LayoutElevationProfile = 65654

LayoutFrame = 65647

LayoutGroup = 65637

LayoutHtml = 65648

LayoutItem = 65636

LayoutLabel = 65641

LayoutLegend = 65642

LayoutManualTable = 65652

LayoutMap = 65639

LayoutMarker = 65653

LayoutPage = 65638

LayoutPicture = 65640

LayoutPolygon = 65644

LayoutPolyline = 65645

LayoutScaleBar = 65646

LayoutShape = 65643

LayoutTextTable = 65650

PluginItem = 75650

addLayoutItemType(self, metadata: QgsLayoutItemAbstractMetadata) → bool

Registers a new layout item type. Takes ownership of the metadata instance.

See also

addLayoutMultiFrameType()

Parameters

metadata (QgsLayoutItemAbstractMetadata) –

Return type

bool

addLayoutMultiFrameType(self, metadata: QgsLayoutMultiFrameAbstractMetadata) → bool

Registers a new layout multiframe type. Takes ownership of the metadata instance.

See also

addLayoutItemType()

Parameters

metadata (QgsLayoutMultiFrameAbstractMetadata) –

Return type

bool

childEvent(self, QChildEvent)

connectNotify(self, QMetaMethod)

createItem(self, type: int, layout: QgsLayout) → QgsLayoutItem

Creates a new instance of a layout item given the item type, and target layout.

See also

createMultiFrame()

Parameters

• type (int) –

• layout (QgsLayout) –

Return type

QgsLayoutItem

createMultiFrame(self, type: int, layout: QgsLayout) → QgsLayoutMultiFrame

Creates a new instance of a layout multiframe given the multiframe type, and target layout.

See also

createItem()

Parameters

• type (int) –

• layout (QgsLayout) –

Return type

QgsLayoutMultiFrame

customEvent(self, QEvent)

disconnectNotify(self, QMetaMethod)

isSignalConnected(self, QMetaMethod) → bool

itemMetadata(self, type: int) → QgsLayoutItemAbstractMetadata

Returns the metadata for the specified item type. Returns None if a corresponding type was not found in the registry.

See also

multiFrameMetadata()

Parameters

type (int) –

Return type

QgsLayoutItemAbstractMetadata

itemTypes(self) → Dict[int, str]

Returns a map of available item types to translated name.

Return type

Dict[int, str]

multiFrameMetadata(self, type: int) → QgsLayoutMultiFrameAbstractMetadata

Returns the metadata for the specified multiframe type. Returns None if a corresponding type was not found in the registry.

See also

itemMetadata()

Parameters

type (int) –

Return type

QgsLayoutMultiFrameAbstractMetadata

multiFrameTypeAdded

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters

• name (str = ...) –

• revision (int = ...) –

• arguments (Sequence = ...) –

Return type

PYQT_SIGNAL

populate(self) → bool

Populates the registry with standard item types. If called on a non-empty registry then this will have no effect and will return False.

Return type

bool

receivers(self, PYQT_SIGNAL) → int

resolvePaths(self, type: int, properties: Dict[str, Any], pathResolver: QgsPathResolver, saving: bool)

Resolve paths in properties of a particular symbol layer. This normally means converting relative paths to absolute paths when loading and converting absolute paths to relative paths when saving.

Parameters

• type (int) –

• properties (Dict[str) –

• pathResolver (QgsPathResolver) –

• saving (bool) –

sender(self) → QObject

senderSignalIndex(self) → int

timerEvent(self, QTimerEvent)

typeAdded

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters

• name (str = ...) –

• revision (int = ...) –

• arguments (Sequence = ...) –

Return type

PYQT_SIGNAL