Class: QgsPlotRubberBand¶
- class qgis.gui.QgsPlotRubberBand¶
Bases:
PyQt5.QtCore.QObject
QgsPlotRubberBand
is an abstract base class for temporary rubber band items in various shapes, for use withinQgsPlotCanvas
widgets.New in version 3.26.
QgsPlotRubberBand(canvas:
QgsPlotCanvas
= None) Constructor for QgsPlotRubberBand.Methods
Returns the brush used for drawing the rubber band.
Returns the canvas associated with the rubber band.
Called when a rubber band use has finished and the rubber band is no longer required.
Returns the pen used for drawing the rubber band.
Sets the
brush
used for drawing the rubber band.Sets the
pen
used for drawing the rubber band.Called when a rubber band should be created at the specified starting
position
(in canvas coordinate space).Called when a rubber band should be updated to reflect a temporary ending
position
(in canvas coordinate space).Calculates an updated bounding box rectangle from a original
start
position and newposition
.- brush(self) QBrush ¶
Returns the brush used for drawing the rubber band.
See also
See also
- Return type:
QBrush
- canvas(self) QgsPlotCanvas ¶
Returns the canvas associated with the rubber band.
- Return type:
- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- finish(self, position: QPointF | QPoint = QPointF(), modifiers: Qt.KeyboardModifiers | Qt.KeyboardModifier = Qt.KeyboardModifiers()) QRectF ¶
Called when a rubber band use has finished and the rubber band is no longer required. Returns the final bounding box of the rubber band.
- Parameters:
position (Union[QPointF) –
modifiers (Union[Qt.KeyboardModifiers) –
- Return type:
QRectF
- isSignalConnected(self, QMetaMethod) bool ¶
- pen(self) QPen ¶
Returns the pen used for drawing the rubber band.
See also
See also
- Return type:
QPen
- receivers(self, PYQT_SIGNAL) int ¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setBrush(self, brush: QBrush | QColor | Qt.GlobalColor | QGradient)¶
Sets the
brush
used for drawing the rubber band.See also
See also
- Parameters:
brush (Union[QBrush) –
- setPen(self, pen: QPen | QColor | Qt.GlobalColor | QGradient)¶
Sets the
pen
used for drawing the rubber band.See also
See also
- Parameters:
pen (Union[QPen) –
- start(self, position: QPointF | QPoint, modifiers: Qt.KeyboardModifiers | Qt.KeyboardModifier)¶
Called when a rubber band should be created at the specified starting
position
(in canvas coordinate space).- Parameters:
position (Union[QPointF) –
modifiers (Union[Qt.KeyboardModifiers) –
- timerEvent(self, QTimerEvent)¶
- update(self, position: QPointF | QPoint, modifiers: Qt.KeyboardModifiers | Qt.KeyboardModifier)¶
Called when a rubber band should be updated to reflect a temporary ending
position
(in canvas coordinate space).- Parameters:
position (Union[QPointF) –
modifiers (Union[Qt.KeyboardModifiers) –
- updateRect(self, start: QPointF | QPoint, position: QPointF | QPoint, constrainSquare: bool, fromCenter: bool) QRectF ¶
Calculates an updated bounding box rectangle from a original
start
position and newposition
. IfconstrainSquare
isTrue
then the bounding box will be forced to a square shape. IffromCenter
isTrue
then the originalstart
position will form the center point of the returned rectangle.- Parameters:
start (Union[QPointF) –
position (Union[QPointF) –
constrainSquare (bool) –
fromCenter (bool) –
- Return type:
QRectF