Class: QgsLayerTreeMapCanvasBridge¶
- class qgis.gui.QgsLayerTreeMapCanvasBridge¶
Bases:
PyQt5.QtCore.QObject
The
QgsLayerTreeMapCanvasBridge
class takes care of updates of layer set forQgsMapCanvas
from a layer tree. The class listens to the updates in the layer tree and updates the list of layers for rendering whenever some layers are added, removed, or their visibility changes.The update of layers is not done immediately - it is postponed, so a series of updates to the layer tree will trigger just one update of canvas layers.
Also allows the client to override the default order of layers. This is useful in advanced cases where the grouping in layer tree should be independent from the actual order in the canvas.
New in version 2.4.
QgsLayerTreeMapCanvasBridge(root:
QgsLayerTree
, canvas:QgsMapCanvas
, parent: QObject = None) Constructor: does not take ownership of the layer tree nor canvasMethods
- rtype:
bool
- rtype:
QgsMapCanvas
Returns associated overview canvas (may be
None
)- rtype:
QgsLayerTree
if enabled, will automatically set full canvas extent and destination CRS + map units when first layer(s) are added
force update of canvas layers from the layer tree.
- param overviewCanvas:
Associates overview canvas with the bridge, so the overview will be updated whenever main canvas is updated
Signals
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
- autoSetupOnFirstLayer(self) bool ¶
- Return type:
bool
- canvasLayersChanged¶
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.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- isSignalConnected(self, QMetaMethod) bool ¶
- mapCanvas(self) QgsMapCanvas ¶
- Return type:
- overviewCanvas(self) QgsMapOverviewCanvas ¶
Returns associated overview canvas (may be
None
)New in version 3.0.
- Return type:
- receivers(self, PYQT_SIGNAL) int ¶
- rootGroup(self) QgsLayerTree ¶
- Return type:
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setAutoSetupOnFirstLayer(self, enabled: bool)¶
if enabled, will automatically set full canvas extent and destination CRS + map units when first layer(s) are added
- Parameters:
enabled (bool) –
- setCanvasLayers(self)¶
force update of canvas layers from the layer tree. Normally this should not be needed to be called.
- setOvervewCanvas(self, overviewCanvas: QgsMapOverviewCanvas)¶
- Parameters:
overviewCanvas (QgsMapOverviewCanvas) –
- setOverviewCanvas(self, overviewCanvas: QgsMapOverviewCanvas)¶
Associates overview canvas with the bridge, so the overview will be updated whenever main canvas is updated
New in version 3.6.
- Parameters:
overviewCanvas (QgsMapOverviewCanvas) –
- timerEvent(self, QTimerEvent)¶