Subgroup: Layout

Class: QgsLayoutItemRegistry

class qgis.core.QgsLayoutItemRegistry(parent: QObject = None)

Bases: PyQt5.QtCore.QObject

Creates a new empty item registry.

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

See also

populate()

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: 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 Emitted whenever a new multiframe type is added to the registry, with the specified type and visible name.
typeAdded Emitted whenever a new item type is added to the registry, with the specified type and visible name.

Attributes

Layout3DMap
LayoutAttributeTable
LayoutFrame
LayoutGroup
LayoutHtml
LayoutItem
LayoutLabel
LayoutLegend
LayoutMap
LayoutPage
LayoutPicture
LayoutPolygon
LayoutPolyline
LayoutScaleBar
LayoutShape
LayoutTextTable
PluginItem
class ItemType

Bases: int

Layout3DMap = 65651
LayoutAttributeTable = 65649
LayoutFrame = 65647
LayoutGroup = 65637
LayoutHtml = 65648
LayoutItem = 65636
LayoutLabel = 65641
LayoutLegend = 65642
LayoutMap = 65639
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.

addLayoutMultiFrameType(self, metadata: QgsLayoutMultiFrameAbstractMetadata) → bool

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

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

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

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()

customEvent()
disconnectNotify()
isSignalConnected()
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.

itemTypes(self) → Dict[int, str]

Returns a map of available item types to translated name.

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()

multiFrameTypeAdded

Emitted whenever a new multiframe type is added to the registry, with the specified type and visible name. [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.

receivers()
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.

sender()
senderSignalIndex()
timerEvent()
typeAdded

Emitted whenever a new item type is added to the registry, with the specified type and visible name. [signal]