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.

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

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.