Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Docstring + import cleanups to legend.py. #16674

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 6, 2020
Merged

Docstring + import cleanups to legend.py. #16674

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 33 additions & 32 deletions lib/matplotlib/legend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,20 @@

.. important::

It is unlikely that you would ever create a Legend instance
manually. Most users would normally create a legend via the
:meth:`~matplotlib.axes.Axes.legend` function. For more details on legends
there is also a :doc:`legend guide </tutorials/intermediate/legend_guide>`.

The Legend class can be considered as a container of legend handles and
legend texts. Creation of corresponding legend handles from the plot elements
in the axes or figures (e.g., lines, patches, etc.) are specified by the
handler map, which defines the mapping between the plot elements and the
legend handlers to be used (the default legend handlers are defined in the
:mod:`~matplotlib.legend_handler` module). Note that not all kinds of
artist are supported by the legend yet by default but it is possible to
extend the legend handler's capabilities to support arbitrary objects. See
the :doc:`legend guide </tutorials/intermediate/legend_guide>` for more
It is unlikely that you would ever create a Legend instance manually.
Most users would normally create a legend via the `~.Axes.legend`
function. For more details on legends there is also a :doc:`legend guide
</tutorials/intermediate/legend_guide>`.

The `Legend` class is a container of legend handles and legend texts.

The legend handler map specifies how to create legend handles from artists
(lines, patches, etc.) in the axes or figures. Default legend handlers are
defined in the :mod:`~matplotlib.legend_handler` module. While not all artist
types are covered by the default legend handlers, custom legend handlers can be
defined to support arbitrary objects.

See the :doc:`legend guide </tutorials/intermediate/legend_guide>` for more
information.
"""

Expand All @@ -26,7 +26,7 @@

import numpy as np

from matplotlib import rcParams
import matplotlib as mpl
from matplotlib import cbook, docstring
from matplotlib.artist import Artist, allow_rasterization
from matplotlib.cbook import silent_list
Expand Down Expand Up @@ -162,7 +162,7 @@ def _update_bbox_to_anchor(self, loc_in_canvas):
ncol : int, default: 1
The number of columns that the legend has.

prop : None or :class:`matplotlib.font_manager.FontProperties` or dict
prop : None or `matplotlib.font_manager.FontProperties` or dict
The font properties of the legend. If None (default), the current
:data:`matplotlib.rcParams` will be used.

Expand Down Expand Up @@ -222,7 +222,7 @@ def _update_bbox_to_anchor(self, loc_in_canvas):
expanded to fill the axes area (or *bbox_to_anchor* if defines
the legend's size).

bbox_transform : None or :class:`matplotlib.transforms.Transform`
bbox_transform : None or `matplotlib.transforms.Transform`
The transform for the bounding box (*bbox_to_anchor*). For a value
of ``None`` (default) the Axes'
:data:`~matplotlib.axes.Axes.transAxes` transform will be used.
Expand Down Expand Up @@ -253,8 +253,8 @@ def _update_bbox_to_anchor(self, loc_in_canvas):

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 :func:`matplotlib.legend.Legend.get_legend_handler_map`.
handler. This *handler_map* updates the default handler map
found at `matplotlib.legend.Legend.get_legend_handler_map`.
""")


Expand Down Expand Up @@ -347,7 +347,7 @@ def __init__(self, parent, handles, labels,
Users can specify any arbitrary location for the legend using the
*bbox_to_anchor* keyword argument. *bbox_to_anchor* can be a
`.BboxBase` (or derived therefrom) or a tuple of 2 or 4 floats.
See :meth:`set_bbox_to_anchor` for more detail.
See `set_bbox_to_anchor` for more detail.

The legend location can be specified by setting *loc* with a tuple of
2 floats, which is interpreted as the lower-left corner of the legend
Expand All @@ -363,11 +363,12 @@ def __init__(self, parent, handles, labels,
if fontsize is not None:
self.prop = FontProperties(size=fontsize)
else:
self.prop = FontProperties(size=rcParams["legend.fontsize"])
self.prop = FontProperties(
size=mpl.rcParams["legend.fontsize"])
else:
self.prop = FontProperties._from_any(prop)
if isinstance(prop, dict) and "size" not in prop:
self.prop.set_size(rcParams["legend.fontsize"])
self.prop.set_size(mpl.rcParams["legend.fontsize"])

self._fontsize = self.prop.get_size_in_points()

Expand All @@ -385,7 +386,7 @@ def __init__(self, parent, handles, labels,
'labelspacing', 'handlelength', 'handletextpad',
'borderaxespad']:
if locals_view[name] is None:
value = rcParams["legend." + name]
value = mpl.rcParams["legend." + name]
else:
value = locals_view[name]
setattr(self, name, value)
Expand Down Expand Up @@ -437,7 +438,7 @@ def __init__(self, parent, handles, labels,

self._loc_used_default = loc is None
if loc is None:
loc = rcParams["legend.loc"]
loc = mpl.rcParams["legend.loc"]
if not self.isaxes and loc in [0, 'best']:
loc = 'upper right'
if isinstance(loc, str):
Expand Down Expand Up @@ -472,14 +473,14 @@ def __init__(self, parent, handles, labels,
# and size of the box will be updated during the drawing time.

if facecolor is None:
facecolor = rcParams["legend.facecolor"]
facecolor = mpl.rcParams["legend.facecolor"]
if facecolor == 'inherit':
facecolor = rcParams["axes.facecolor"]
facecolor = mpl.rcParams["axes.facecolor"]

if edgecolor is None:
edgecolor = rcParams["legend.edgecolor"]
edgecolor = mpl.rcParams["legend.edgecolor"]
if edgecolor == 'inherit':
edgecolor = rcParams["axes.edgecolor"]
edgecolor = mpl.rcParams["axes.edgecolor"]

self.legendPatch = FancyBboxPatch(
xy=(0.0, 0.0), width=1., height=1.,
Expand All @@ -493,7 +494,7 @@ def __init__(self, parent, handles, labels,
# draw()) to the length that includes the padding. Thus we set
# pad=0 here.
if fancybox is None:
fancybox = rcParams["legend.fancybox"]
fancybox = mpl.rcParams["legend.fancybox"]

if fancybox:
self.legendPatch.set_boxstyle("round", pad=0,
Expand All @@ -505,7 +506,7 @@ def __init__(self, parent, handles, labels,

self._drawFrame = frameon
if frameon is None:
self._drawFrame = rcParams["legend.frameon"]
self._drawFrame = mpl.rcParams["legend.frameon"]

# init with null renderer
self._init_legend_box(handles, labels, markerfirst)
Expand All @@ -516,7 +517,7 @@ def __init__(self, parent, handles, labels,
if shadow:
self.get_frame().set_alpha(1)
else:
self.get_frame().set_alpha(rcParams["legend.framealpha"])
self.get_frame().set_alpha(mpl.rcParams["legend.framealpha"])
else:
self.get_frame().set_alpha(framealpha)

Expand All @@ -526,7 +527,7 @@ def __init__(self, parent, handles, labels,

# figure out title fontsize:
if title_fontsize is None:
title_fontsize = rcParams['legend.title_fontsize']
title_fontsize = mpl.rcParams['legend.title_fontsize']
tprop = FontProperties(size=title_fontsize)
self.set_title(title, prop=tprop)
self._draggable = None
Expand Down