fsleyes.profiles.timeseriesprofile

This module provides the TimeSeriesProfile class, an interaction profile for the TimeSeriesPanel.

class fsleyes.profiles.timeseriesprofile.TimeSeriesProfile(viewPanel, overlayList, displayCtx)

Bases: fsleyes.profiles.plotprofile.PlotProfile

The TimeSeriesProfile is a PlotProfile for use with the TimeSeriesPanel.

In addition to the panzoom mode provided by the PlotProfile class, the TimeSeriesProfile class implements a volume mode, in which the user is able to click/drag on a plot to change the VolumeOpts.volume for the currently selected overlay.

static supportedView()

Returns the TimeSeriesPanel class.

static tempModes()

Returns the temporary mode map for the TimeSeriesProfile, which controls the use of modifier keys to temporarily enter other interaction modes.

__init__(viewPanel, overlayList, displayCtx)

Create a TimeSeriesProfile.

Parameters

• viewPanel – A TimeSeriesPanel instance.

• overlayList – The OverlayList instance.

• displayCtx – The DisplayContext instance.

__volumeModeCompatible()

Returns True if a volume line can currently be shown, False otherwise.

__updateVolume(volumeLine, xvalue)

Called by the volume event handlers. Updates the given volumeLine artist (assumed to be a matplotlib.Line2D instance) so that it is located at the given xvalue. Also updates the VolumeOpts.volume property of the currently selected overlay accordingly.

_volumeModeLeftMouseDown(ev, canvas, mousePos, canvasPos)

Adds a vertical line to the plot at the current volume.

_volumeModeLeftMouseDrag(ev, canvas, mousePos, canvasPos)

Updates the position of the vertical volume line.

_volumeModeLeftMouseUp(ev, canvas, mousePos, canvasPos)

Removes the vertical volume line.

__module__ = 'fsleyes.profiles.timeseriesprofile'