Skip to content

Added remove methods for legends in figure and axes objects #2798

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 4 commits into from
Feb 10, 2014
Merged

Added remove methods for legends in figure and axes objects #2798

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fbcaec5
ENH: Added remove methods for legends in figure and axes objects
cimarronm Feb 9, 2014
e7f051f
TST: Added tests for remove of legends on figure and axes objects
cimarronm Feb 9, 2014
4ee1b31
BLD: Replaced assert_is import from nose.tools in test_legend as pyth…
cimarronm Feb 10, 2014
d1ad5d2
STY: pep8 fixes to test_legend.py
cimarronm Feb 10, 2014
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
1 change: 1 addition & 0 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -509,6 +509,7 @@ def legend(self, *args, **kwargs):
raise TypeError('Invalid arguments to legend.')

self.legend_ = mlegend.Legend(self, handles, labels, **kwargs)
self.legend_._remove_method = lambda h: setattr(self, 'legend_', None)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can remove the unused lambda argument.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The artist remove method calls _remove_method with self so it needs an argument even if not used.

Otherwise you get

TypeError: <lambda>() takes 0 positional arguments but 1 was given

return self.legend_

def text(self, x, y, s, fontdict=None,
Expand Down
1 change: 1 addition & 0 deletions lib/matplotlib/figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1166,6 +1166,7 @@ def legend(self, handles, labels, *args, **kwargs):
"""
l = Legend(self, handles, labels, *args, **kwargs)
self.legends.append(l)
l._remove_method = lambda h: self.legends.remove(h)
return l

@docstring.dedent_interpd
Expand Down
27 changes: 20 additions & 7 deletions lib/matplotlib/tests/test_legend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,21 +80,21 @@ def test_framealpha():
plt.legend(framealpha=0.5)


@image_comparison(baseline_images=['scatter_rc3','scatter_rc1'], remove_text=True)
@image_comparison(baseline_images=['scatter_rc3', 'scatter_rc1'], remove_text=True)
def test_rc():
# using subplot triggers some offsetbox functionality untested elsewhere
fig = plt.figure()
ax = plt.subplot(121)
ax = plt.subplot(121)
ax.scatter(list(xrange(10)), list(xrange(10, 0, -1)), label='three')
ax.legend(loc="center left", bbox_to_anchor=[1.0, 0.5],
title="My legend")
title="My legend")

mpl.rcParams['legend.scatterpoints'] = 1
fig = plt.figure()
ax = plt.subplot(121)
ax = plt.subplot(121)
ax.scatter(list(xrange(10)), list(xrange(10, 0, -1)), label='one')
ax.legend(loc="center left", bbox_to_anchor=[1.0, 0.5],
title="My legend")
title="My legend")


@image_comparison(baseline_images=['legend_expand'], remove_text=True)
Expand All @@ -113,6 +113,19 @@ def test_legend_expand():
ax.legend(loc=3, mode=mode, ncol=2)


@cleanup
def test_legend_remove():
fig = plt.figure()
ax = fig.add_subplot(1, 1, 1)
lines = ax.plot(range(10))
leg = fig.legend(lines, "test")
leg.remove()
assert_equal(fig.legends, [])
leg = ax.legend("test")
leg.remove()
assert ax.get_legend() is None


class TestLegendFunction(object):
# Tests the legend function on the Axes and pyplot.

Expand Down Expand Up @@ -154,8 +167,8 @@ def __call__(self, legend, orig_handle, fontsize, handlebox):
handler_map={None: AnyObjectHandler()})

warn.assert_called_with(u'Legend handers must now implement a '
'"legend_artist" method rather than '
'being a callable.',
'"legend_artist" method rather than '
'being a callable.',
MatplotlibDeprecationWarning,
stacklevel=1)

Expand Down