eelbrain.plot.Butterfly.plot_legend

Butterfly.plot_legend(self, loc='fig', labels=None, *args, **kwargs)

Plot the legend (or remove it from the figure).

Parameters:
loc : False | ‘fig’ | ‘draggable’ | str | int

Where to plot the legend (see Notes; default ‘fig’).

labels : dict

Dictionary with alternate labels for all cells.

… :

Parameters for eelbrain.plot.Legend.

Returns:
legend_figure : None | legend

If loc==’fig’ the Figure, otherwise None.

Notes

legend content can be modified through the figure’s legend_handles and legend_labels attributes.

Possible values for the loc argument:

False:
Make the current legend invisible
‘fig’:
Plot the legend in a new figure
‘draggable’:
The legend can be dragged to the desired position with the mouse pointer.
str | int:
Matplotlib position argument: plot the legend on the figure

Matplotlib Position Arguments:

  • ‘upper right’ : 1,
  • ‘upper left’ : 2,
  • ‘lower left’ : 3,
  • ‘lower right’ : 4,
  • ‘right’ : 5,
  • ‘center left’ : 6,
  • ‘center right’ : 7,
  • ‘lower center’ : 8,
  • ‘upper center’ : 9,
  • ‘center’ : 10,