fsleyes.controls.plotlistpanel

This module provides the PlotListPanel a FSLeyes control panel which allows the user to add/remove DataSeries from an OverlayPlotPanel.

class fsleyes.controls.plotlistpanel.PlotListPanel(parent, overlayList, displayCtx, plotPanel)

Bases: fsleyes.controls.controlpanel.ControlPanel

The PlotListPanel is a FSLeyes control panel for use with OverlayPlotPanel views. It allows the user to add and remove DataSeries instances from the PlotPanel.dataSeries list.

For every DataSeries instance in the PlotPanel.dataSeries list of the OverlayPlotPanel, the PlotListPanel creates a DataSeriesWidget, which allows the user to change the display settings of the DataSeries instance. A EditableListBox is used to display the labels for each DataSeries instance, and the associated DataSeriesWidget controls.

static supportedViews()

The PlotListPanel is restricted for use with OverlayPlotPanel views. This method may be overridden by sub-classes.

static defaultLayout()

Returns a dictionary containing layout settings to be passed to ViewPanel.togglePanel.

__init__(parent, overlayList, displayCtx, plotPanel)

Create a PlotListPanel.

Parameters

• parent – The wx parent object.

• overlayList – The OverlayList.

• displayCtx – The DisplayContext instance.

• plotPanel – The OverlayPlotPanel associated with this PlotListPanel.

destroy()

Must be called when this PlotListPanel is no longer needed. Removes some property listeners, and calls the ControlPanel.destroy() method.

property dsList

Return a reference to the EditableListBox widget that contains the list of DataSeries.

dataSeriesChanged(*a)

Called when the PlotPanel.dataSeries list of the OverlayPlotPanel changes. Updates the list of TimeSeriesWidget controls.

onListAdd(ev)

Called when the user pushes the add button on the EditableListBox. Adds the DataSeries associated with the currently selected overlay to the PlotPanel.dataSeries list of the OverlayPlotPanel.

onListEdit(ev)

Called when the user edits a label on the EditableListBox. Updates the DataSeries.label property of the corresponding DataSeries instance.

onListSelect(ev)

Called when the user selects an item in the EditableListBox. Sets the DisplayContext.selectedOverlay to the overlay associated with the corresponding DataSeries instance.

onListRemove(ev)

Called when the user removes an item from the EditableListBox. Removes the corresponding DataSeries instance from the PlotPanel.dataSeries list of the OverlayPlotPanel.

__module__ = 'fsleyes.controls.plotlistpanel'

class fsleyes.controls.plotlistpanel.DataSeriesWidget(parent, dataSeries)

Bases: __main__.docbuilder.run.<locals>.MockClass

The DataSeriesWidget class is a panel which contains controls that modify the properties of a DataSeries instance. A DataSeriesWidget is created by the PlotListPanel for every DataSeries in the PlotPanel.dataSeries list.

__init__(parent, dataSeries)

Create a DataSeriesWidget.

Parameters

• parent – The wx parent object.

• dataSeries – The DataSeries instance.

__module__ = 'fsleyes.controls.plotlistpanel'