- loc : int or string or pair of floats, default:
rcParams["legend.loc"] ('best' for axes, 'upper right' for figures)
The location of the legend. Possible codes are:
| Location String |
Location Code |
|---|
| 'best' |
0 |
| '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 |
Alternatively can be a 2-tuple giving x, y of the lower-left
corner of the legend in axes coordinates (in which case
bbox_to_anchor will be ignored).
The 'best' option can be quite slow for plots with large amounts
of data. Your plotting speed may benefit from providing a specific
location.
- bbox_to_anchor :
BboxBase, 2-tuple, or 4-tuple of floats
Box that is used to position the legend in conjunction with loc.
Defaults to axes.bbox (if called as a method to Axes.legend) or
figure.bbox (if Figure.legend). This argument allows arbitrary
placement of the legend.
Bbox coordinates are interpreted in the coordinate system given by
bbox_transform, with the default transform
Axes or Figure coordinates, depending on which legend is called.
If a 4-tuple or BboxBase is given, then it specifies the bbox
(x, y, width, height) that the legend is placed in.
To put the legend in the best location in the bottom right
quadrant of the axes (or figure):
loc='best', bbox_to_anchor=(0.5, 0., 0.5, 0.5)
A 2-tuple (x, y) places the corner of the legend specified by loc at
x, y. For example, to put the legend's upper right-hand corner in the
center of the axes (or figure) the following keywords can be used:
loc='upper right', bbox_to_anchor=(0.5, 0.5)
- ncol : integer
The number of columns that the legend has. Default is 1.
- prop : None or
matplotlib.font_manager.FontProperties or dict
The font properties of the legend. If None (default), the current
matplotlib.rcParams will be used.
- fontsize : int or float or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
Controls the font size of the legend. If the value is numeric the
size will be the absolute font size in points. String values are
relative to the current default font size. This argument is only
used if prop is not specified.
- numpoints : None or int
The number of marker points in the legend when creating a legend
entry for a Line2D (line).
Default is None, which will take the value from
rcParams["legend.numpoints"].
- scatterpoints : None or int
The number of marker points in the legend when creating
a legend entry for a PathCollection (scatter plot).
Default is None, which will take the value from
rcParams["legend.scatterpoints"].
- scatteryoffsets : iterable of floats
The vertical offset (relative to the font size) for the markers
created for a scatter plot legend entry. 0.0 is at the base the
legend text, and 1.0 is at the top. To draw all markers at the
same height, set to [0.5]. Default is [0.375, 0.5, 0.3125].
- markerscale : None or int or float
The relative size of legend markers compared with the originally
drawn ones.
Default is None, which will take the value from
rcParams["legend.markerscale"].
- markerfirst : bool
If True, legend marker is placed to the left of the legend label.
If False, legend marker is placed to the right of the legend
label.
Default is True.
- frameon : None or bool
Control whether the legend should be drawn on a patch
(frame).
Default is None, which will take the value from
rcParams["legend.frameon"].
- fancybox : None or bool
Control whether round edges should be enabled around the
FancyBboxPatch which makes up the
legend's background.
Default is None, which will take the value from
rcParams["legend.fancybox"].
- shadow : None or bool
Control whether to draw a shadow behind the legend.
Default is None, which will take the value from
rcParams["legend.shadow"].
- framealpha : None or float
Control the alpha transparency of the legend's background.
Default is None, which will take the value from
rcParams["legend.framealpha"]. If shadow is activated and
framealpha is None, the default value is ignored.
- facecolor : None or "inherit" or a color spec
Control the legend's background color.
Default is None, which will take the value from
rcParams["legend.facecolor"]. If "inherit", it will take
rcParams["axes.facecolor"].
- edgecolor : None or "inherit" or a color spec
Control the legend's background patch edge color.
Default is None, which will take the value from
rcParams["legend.edgecolor"] If "inherit", it will take
rcParams["axes.edgecolor"].
- mode : {"expand", None}
If mode is set to "expand" the legend will be horizontally
expanded to fill the axes area (or bbox_to_anchor if defines
the legend's size).
- bbox_transform : None or
matplotlib.transforms.Transform
The transform for the bounding box (bbox_to_anchor). For a value
of None (default) the Axes'
transAxes transform will be used.
- title : str or None
The legend's title. Default is no title (None).
- title_fontsize: str or None
The fontsize of the legend's title. Default is the default fontsize.
- borderpad : float or None
The fractional whitespace inside the legend border.
Measured in font-size units.
Default is None, which will take the value from
rcParams["legend.borderpad"].
- labelspacing : float or None
The vertical space between the legend entries.
Measured in font-size units.
Default is None, which will take the value from
rcParams["legend.labelspacing"].
- handlelength : float or None
The length of the legend handles.
Measured in font-size units.
Default is None, which will take the value from
rcParams["legend.handlelength"].
- handletextpad : float or None
The pad between the legend handle and text.
Measured in font-size units.
Default is None, which will take the value from
rcParams["legend.handletextpad"].
- borderaxespad : float or None
The pad between the axes and legend border.
Measured in font-size units.
Default is None, which will take the value from
rcParams["legend.borderaxespad"].
- columnspacing : float or None
The spacing between columns.
Measured in font-size units.
Default is None, which will take the value from
rcParams["legend.columnspacing"].
- handler_map : dict or None
The custom dictionary mapping instances or types to a legend
handler. This handler_map updates the default handler map
found at matplotlib.legend.Legend.get_legend_handler_map().
