Class: QgsLayoutSerializableObject

class qgis.core.QgsLayoutSerializableObject

Bases: qgis._core.QgsLayoutUndoObjectInterface

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

New in version 3.0: Methods

createCommand
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.

Signals

Attributes

createCommand(self, text: str, id: int, parent: QUndoCommand = None) → QgsAbstractLayoutUndoCommand
layout(self) → QgsLayout

Returns the layout the object belongs to.

readXml(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool

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

See also

writeXml()

stringType(self) → str

Returns the object type as a string.

This string must be a unique, single word, character only representation of the item type, eg “LayoutScaleBar”

writeXml(self, parentElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool

Stores the objects’s state in a DOM element. The parentElement should refer to the parent layout’s DOM element.

See also

readXml()