Class: QgsLayoutViewToolAddNodeItem

Layout view tool for adding node based items to a layout.

Class Hierarchy

Base classes

QgsLayoutViewTool	Abstract base class for all layout view tools. Layout view tools are user interactive tools for manipulating and adding items to QgsLayoutView widgets.
QObject

Methods

itemMetadataId	Returns the item metadata id for items created by the tool.
setItemMetadataId	Sets the item metadata metadataId for items created by the tool.

Signals

createdItem

Emitted when an item has been created using the tool.

class qgis.gui.QgsLayoutViewToolAddNodeItem

Bases: QgsLayoutViewTool

__init__(view: QgsLayoutView | None)

Constructs a QgsLayoutViewToolAddNodeItem for the given layout view.

Parameters:

view (Optional[QgsLayoutView])

signal createdItem

Emitted when an item has been created using the tool.

itemMetadataId(self) → int

Returns the item metadata id for items created by the tool.

See also

setItemMetadataId()

Return type:

int

setItemMetadataId(self, metadataId: int)

Sets the item metadata metadataId for items created by the tool.

The metadataId associates the current tool behavior with a metadata entry from QgsLayoutItemGuiRegistry.

See also

itemMetadataId()

Parameters:

metadataId (int)