fsleyes.profiles.plotprofile
¶
This module contains the PlotProfile
class, a Profile
for use with PlotPanel
views.
-
class
fsleyes.profiles.plotprofile.
PlotProfile
(viewPanel, overlayList, displayCtx, extraModes=None)¶ Bases:
fsleyes.profiles.Profile
The
PlotProfile
class is the default interaction profile forPlotPanel
vies. It provides pan and zoom functionality via a singleProfile.mode
calledpanzoom
:- Left click and drag to pan the plot
- Right click and drag to zoom the plot.
-
__init__
(viewPanel, overlayList, displayCtx, extraModes=None)¶ Create a
PlotProfile
.Parameters: - viewPanel – A
PlotPanel
instance. - overlayList – The
OverlayList
instance. - displayCtx – The
DisplayContext
instance. - extraModes – Extra modes to pass through to the
Profile
constructor.
- viewPanel – A
-
destroy
()¶ Must be called when this
PlotProfile
is no longer needed. Clears references and calls the base classdestroy
method.
-
getEventTargets
()¶ Overrides
Profile.getEventTargets()
. Returns thematplotlib
Canvas
object displayed in thePlotPanel
.
-
_panzoomModeLeftMouseDown
(ev, canvas, mousePos, canvasPos)¶ Called on left mouse clicks. Enables panning.
-
_panzoomModeLeftMouseDrag
(ev, canvas, mousePos, canvasPos)¶ Called on left mouse drags. Updates the
PlotPanel.limits
property - the panning logic is provided by thematplotlib
NavigationToolbar2wx
class.
-
_panzoomModeLeftMouseUp
(ev, canvas, mousePos, canvasPos)¶ Called on left mouse up events. Disables panning.
-
_panzoomModeRightMouseDown
(ev, canvas, mousePos, canvasPos)¶ Called on right mouse clicks. Enables zooming.
-
_panzoomModeRightMouseDrag
(ev, canvas, mousePos, canvasPos)¶ Called on right mouse drags. Updates the
PlotPanel.limits
property - the zooming logic is provided by thematplotlib
NavigationToolbar2wx
class.
-
_panzoomModeRightMouseUp
(ev, canvas, mousePos, canvasPos)¶ Called on right mouse up events. Disables panning.
-
_PlotProfile__updateAxisLimits
()¶ Called by the
panzoom
MouseDrag
event handlers. Makes sure that thePlotPanel.limits
property is up to date.
-
__module__
= 'fsleyes.profiles.plotprofile'¶