Axes.legend

Axes.legend(handles=None, labels=None, *, loc=None, width=None, space=None, queue=False, **kwargs)[source]

Add an inset legend or outer legend along the edge of the axes. See legend_extras for details.

Parameters

  • loc (int or str, optional) – The legend location. The following location keys are valid:

    Location

    Valid keys

    outer left

    'left', 'l'

    outer right

    'right', 'r'

    outer bottom

    'bottom', 'b'

    outer top

    'top', 't'

    “best” inset

    'best', 'inset', 'i', 0

    upper right inset

    'upper right', 'ur', 1

    upper left inset

    'upper left', 'ul', 2

    lower left inset

    'lower left', 'll', 3

    lower right inset

    'lower right', 'lr', 4

    center left inset

    'center left', 'cl', 5

    center right inset

    'center right', 'cr', 6

    lower center inset

    'lower center', 'lc', 7

    upper center inset

    'upper center', 'uc', 8

    center inset

    'center', 'c', 9

    “filled”

    'fill'

  • width (float or str, optional) – For outer legends only. The space allocated for the legend box. This does nothing if rc.tight is True. Units are interpreted by units.

  • space (float or str, optional) – For outer legends only. The space between the axes and the legend box. Units are interpreted by units. When rc.tight is True, this is adjusted automatically. Otherwise, the default is rc[‘subplots.panelpad’] = '0.5em'.

  • queue (bool, optional) – If True and loc is the same as an existing legend, the handles and labels are added to a queue and this function returns None. This is used to “update” the same legend with successive ax.legend(...) calls. If False (the default) and loc is the same as an existing legend, this function returns a Legend instance and the old legend is removed from the axes.

Other Parameters

*args, **kwargs – Passed to legend_extras.

See also

proplot.figure.Figure.legend, proplot.axes.legend_extras