eelbrain.plot.Butterfly.plot_legend

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

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

Parameters

  • loc (Optional[Union[str, int, Tuple[float, float], bool]]) – Where to plot the legend (see Notes; default ‘fig’).

  • labels (Dict[Union[str, Tuple[str, ...]], str]) – Dictionary with alternate labels for all cells.

  • ... – Additional legend parameters (for eelbrain.plot.Legend if loc=='fig', otherwise for matplotlib.figure.Figure.legend).

Returns

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

Return type

None | legend

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 | (float, float):

Matplotlib legend() position argument.