Class: QgsMapViewsManager

Manages storage of a set of views.

QgsMapViewsManager handles the storage, serializing and deserializing of views. Usually this class is not constructed directly, but rather accessed through a QgsProject via QgsProject.viewsManager().

Added in version 3.24.

Class Hierarchy

Inheritance diagram of qgis.core.QgsMapViewsManager

Base classes

QObject

class qgis.core.QgsMapViewsManager[source]

Bases: QObject

__init__(project: QgsProject | None)

Constructor for QgsMapViewsManager. The project will become the parent object for this manager.

Parameters:

project (Optional[QgsProject])

clear(self)[source]

Removes and deletes all views from the manager.

readXml(self, element: QDomElement, doc: QDomDocument) bool[source]

Reads the manager’s state from a DOM element, restoring all views present in the XML document

See also

writeXml()

Parameters:
  • element (QDomElement)

  • doc (QDomDocument)

Return type:

bool

remove3DView(self, name: str | None)[source]

Removes the configuration of the 3D view named name

Parameters:

name (Optional[str])

rename3DView(self, oldTitle: str | None, newTitle: str | None)[source]

Renames the 3D view named oldTitle to newTitle

Parameters:
  • oldTitle (Optional[str])

  • newTitle (Optional[str])

signal views3DListChanged[source]

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.

writeXml(self, doc: QDomDocument) QDomElement[source]

Returns a DOM element representing the state of the manager.

See also

readXml()

Parameters:

doc (QDomDocument)

Return type:

QDomElement