Class: QgsPrintLayout

Print layout, a QgsLayout subclass for static or atlas-based layouts.

Class Hierarchy

Base classes

QgsLayout	Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
QGraphicsScene
QObject
QgsExpressionContextGenerator	Abstract interface for generating an expression context.
QgsLayoutUndoObjectInterface	Interface for layout objects which support undo/redo commands.
QgsMasterLayoutInterface	Interface for master layout type objects, such as print layouts and reports.

Methods

atlas

Returns the print layout's atlas.

Signals

nameChanged

Emitted when the layout's name is changed.

class qgis.core.QgsPrintLayout

Bases: QgsLayout, QgsMasterLayoutInterface

__init__(project: QgsProject | None)

Constructor for QgsPrintLayout.

Parameters:

project (Optional[QgsProject])

atlas(self) → QgsLayoutAtlas | None

Returns the print layout’s atlas.

Return type:

Optional[QgsLayoutAtlas]

signal nameChanged(name: str)

Emitted when the layout’s name is changed.

See also

setName()

Parameters:

name (str)