Class: QgsLayoutSerializableObject¶

An interface for layout objects which can be stored and read from DOM elements.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: layout(), readXml(), stringType(), writeXml()

Class Hierarchy¶

Interface for layout objects which support undo/redo commands.

`QgsLayoutAtlas`	Used to render `QgsLayout` as an atlas, by iterating over the features from an associated vector layer.
`QgsLayoutGridSettings`	Contains settings relating to the appearance, spacing and offset for layout grids.
`QgsLayoutGuideCollection`	Stores and manages the snap guides used by a layout.
`QgsLayoutPageCollection`	A manager for a collection of pages in a layout.
`QgsLayoutSnapper`	Manages snapping grids and preset snap lines in a layout, and handles snapping points to the nearest grid coordinate/snap line when possible.

Abstract Methods

`layout`	Returns the layout the object belongs to.
`readXml`	Sets the objects's state from a DOM element.
`stringType`	Returns the object type as a string.
`writeXml`	Stores the objects's state in a DOM element.

class qgis.core.QgsLayoutSerializableObject[source]¶

abstract layout(self) → QgsLayout | None[source]¶

Returns the layout the object belongs to.

abstract readXml(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool[source]¶

Sets the objects’s state from a DOM element. element is the DOM node corresponding to the object.