If Legend shadow=True set framealpha=1 if not passed explicitly instead of consulting rcParams #8988

s0vereign · 2017-08-04T11:47:36Z

PR Summary

This PR fixes a behavior in the legend, that if shadow is set True
the legend will be grayed out.

The changes are in detail:

Change legend behavior in constructor for framealpha,
so that not the rcParams are not consulted if shadow is set
to True and framealpha was not passed.
Added a testcase which check for the desired behavior

The following code:

import matplotlib.pyplot as plt
import numpy as np

x = np.linspace(0,100)
fig, ax = plt.subplots()
ax.plot(x,x**2,label="test")
leg = ax.legend(shadow=True, facecolor='w')
plt.show()

results in:

The PR fixes Issue #8943 according to @tacaswell instructions.

PR Checklist

[✅] Has Pytest style unit tests
[✅] Code is PEP 8 compliant
New features are documented, with examples if plot related
Documentation is sphinx and numpydoc compliant
Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

WeatherGod · 2017-08-04T13:34:25Z

lib/matplotlib/legend.py

+            if shadow is True:
+                self.framealpha = 1
+            else:
+                self.get_frame().set_alpha(rcParams["legend.framealpha"])


why are there two ways of setting framealpha? I would stick with the self.get_frame().set_alpha() way, unless we should change it everywhere to self.framealpha. Also, we don't need shadow is True, it can be just shadow.

Alright will change both lines as proposed.

the test to use the get_alpha method

tacaswell · 2017-08-05T02:11:41Z

lib/matplotlib/tests/test_legend.py

+    fig, ax = plt.subplots()
+    ax.plot(range(100), label="test")
+    leg = ax.legend(shadow=True, facecolor='w')
+    assert leg.get_frame().get_alpha() == 1


This will need a new (empty) line at the end to assuage pep8

tacaswell

👍 for the code.

This case of ignoring the default facealpha needs to be documented in Axes.legend.

Thanks for you work on this!

tacaswell · 2017-08-05T02:17:24Z

lib/matplotlib/legend.py

@@ -384,8 +384,13 @@ def __init__(self, parent, handles, labels,
        # init with null renderer
        self._init_legend_box(handles, labels, markerfirst)

+        # If shadow is activated use framealpha if not


This comment is perfect here! Can you also add a note about this to the docstring at https://github.com/matplotlib/matplotlib/blob/master/lib/matplotlib/axes/_axes.py#L298 ?

Always glad to help. 👍

I would put it into the doc of framealpha:

matplotlib/lib/matplotlib/axes/_axes.py

Line 427 in 5a24121

framealpha : None or float

to make clear that if shadow is activated and framealpha is None it will set the value to be 1 instead of taking it from legend.framealpha :data:rcParam<matplotlib.rcParams>.

Should I also add something to

matplotlib/lib/matplotlib/axes/_axes.py

Line 422 in 5a24121

shadow : None or bool

?

To both? The goal is to make sure users are not confused / can un-confuse them selves easily. Putting it in shadow warns someone using it that it might affect other parts and someone who is having issues with the default framalpha being ignored might go check it's docstring.

for ignoring framealpha default value if shadow is activated.

s0vereign · 2017-08-11T10:50:54Z

@tacaswell did you have a look over the recent changes?

dstansby

👍 LGTM

tacaswell · 2017-08-11T17:08:16Z

Thank @s0vereign and congratulations on your first Matplotlib PR 🎉

Hopefully we will hear from you again!

s0vereign · 2017-08-12T21:23:46Z

Will be looking for issues I can fix and get more familiar with the code 👍

tacaswell · 2017-08-12T21:31:39Z

@s0vereign have a look at https://github.com/matplotlib/matplotlib/issues?q=is%3Aopen+is%3Aissue+label%3Anew-contributor-friendly

s0vereign added 3 commits August 4, 2017 12:21

Added the Fix for Issue 8943 and a simple testcase.

04ef849

removed unecessary lines

0808634

Fixed pep8 violations in test case

538da87

WeatherGod reviewed Aug 4, 2017

View reviewed changes

alpha of legend is now set with set_alpha method and thus changed

a030a8d

the test to use the get_alpha method

tacaswell reviewed Aug 5, 2017

View reviewed changes

tacaswell requested changes Aug 5, 2017

View reviewed changes

tacaswell added this to the 2.1.1 (next bug fix release) milestone Aug 5, 2017

s0vereign added 2 commits August 9, 2017 15:33

Added blank line in test_legend.py at EOF for pep8 compliance

569c4f5

Added lines to lib/matplotlib/axes/_axes.py to account

755d9c8

for ignoring framealpha default value if shadow is activated.

dstansby approved these changes Aug 11, 2017

View reviewed changes

tacaswell approved these changes Aug 11, 2017

View reviewed changes

tacaswell merged commit 363e25f into matplotlib:master Aug 11, 2017

tacaswell modified the milestones: 2.1 (next point release), 2.1.1 (next bug fix release) Aug 11, 2017

s0vereign deleted the shadowfix branch August 12, 2017 21:23

tacaswell mentioned this pull request Aug 13, 2017

Using shadow=True does not allow for white background in ax.legend #8943

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

If Legend shadow=True set framealpha=1 if not passed explicitly instead of consulting rcParams #8988

If Legend shadow=True set framealpha=1 if not passed explicitly instead of consulting rcParams #8988

Uh oh!

s0vereign commented Aug 4, 2017

Uh oh!

WeatherGod Aug 4, 2017

Uh oh!

s0vereign Aug 4, 2017 •

edited

Loading

Uh oh!

tacaswell Aug 5, 2017

Uh oh!

tacaswell left a comment

Uh oh!

tacaswell Aug 5, 2017

Uh oh!

s0vereign Aug 9, 2017 •

edited

Loading

Uh oh!

tacaswell Aug 9, 2017

Uh oh!

s0vereign commented Aug 11, 2017

Uh oh!

dstansby left a comment

Uh oh!

tacaswell commented Aug 11, 2017

Uh oh!

s0vereign commented Aug 12, 2017

Uh oh!

tacaswell commented Aug 12, 2017

Uh oh!

Uh oh!

Uh oh!

If Legend shadow=True set framealpha=1 if not passed explicitly instead of consulting rcParams #8988

If Legend shadow=True set framealpha=1 if not passed explicitly instead of consulting rcParams #8988

Uh oh!

Conversation

s0vereign commented Aug 4, 2017

PR Summary

PR Checklist

Uh oh!

WeatherGod Aug 4, 2017

Choose a reason for hiding this comment

Uh oh!

s0vereign Aug 4, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tacaswell Aug 5, 2017

Choose a reason for hiding this comment

Uh oh!

tacaswell left a comment

Choose a reason for hiding this comment

Uh oh!

tacaswell Aug 5, 2017

Choose a reason for hiding this comment

Uh oh!

s0vereign Aug 9, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tacaswell Aug 9, 2017

Choose a reason for hiding this comment

Uh oh!

s0vereign commented Aug 11, 2017

Uh oh!

dstansby left a comment

Choose a reason for hiding this comment

Uh oh!

tacaswell commented Aug 11, 2017

Uh oh!

s0vereign commented Aug 12, 2017

Uh oh!

tacaswell commented Aug 12, 2017

Uh oh!

Uh oh!

s0vereign Aug 4, 2017 •

edited

Loading

s0vereign Aug 9, 2017 •

edited

Loading