Skip to content

Legend edgecolor face #20265

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 2 commits into from
May 20, 2021
Merged

Legend edgecolor face #20265

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81a9464
Simplify legend handler for PolyCollections.
efiring May 19, 2021
155ae9f
Add test stolen from @jklymak #20260; fix flake8 warning.
efiring May 19, 2021
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
31 changes: 14 additions & 17 deletions lib/matplotlib/legend_handler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ def legend_artist(self, legend, orig_handle, fontsize, handlebox)
from matplotlib.lines import Line2D
from matplotlib.patches import Rectangle
import matplotlib.collections as mcoll
import matplotlib.colors as mcolors


def update_from_first_child(tgt, src):
Expand Down Expand Up @@ -734,32 +733,30 @@ class HandlerPolyCollection(HandlerBase):
"""
def _update_prop(self, legend_handle, orig_handle):
def first_color(colors):
if colors is None:
return None
colors = mcolors.to_rgba_array(colors)
if len(colors):
return colors[0]
else:
return "none"
if colors.size == 0:
return (0, 0, 0, 0)
return tuple(colors[0])

def get_first(prop_array):
if len(prop_array):
return prop_array[0]
else:
return None
edgecolor = getattr(orig_handle, '_original_edgecolor',
orig_handle.get_edgecolor())
legend_handle.set_edgecolor(first_color(edgecolor))
facecolor = getattr(orig_handle, '_original_facecolor',
orig_handle.get_facecolor())
legend_handle.set_facecolor(first_color(facecolor))
legend_handle.set_fill(orig_handle.get_fill())
legend_handle.set_hatch(orig_handle.get_hatch())

# orig_handle is a PolyCollection and legend_handle is a Patch.
# Directly set Patch color attributes (must be RGBA tuples).
legend_handle._facecolor = first_color(orig_handle.get_facecolor())
Copy link
Member

Choose a reason for hiding this comment

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

This is more invasive than my change so a couple of questions. 1) why set directly? 2) does this cover more cases, in which case should we add more tests?

Copy link
Member Author

Choose a reason for hiding this comment

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

  1. We want all the special-case handling to be done by the PolyCollection, after which we simply hand off the results to the Patch. See https://github.com/matplotlib/matplotlib/blob/master/lib/matplotlib/patches.py#L249 for another example of this approach.
  2. I don't know. I think it is more a question of whether enough legend with/without hatching cases are tested than of any expected changes in behavior.
    More invasive? You could describe it that way, but I view it as a cleanup and an overall simplification.

legend_handle._edgecolor = first_color(orig_handle.get_edgecolor())
legend_handle._fill = orig_handle.get_fill()
legend_handle._hatch = orig_handle.get_hatch()
# Hatch color is anomalous in having no getters and setters.
legend_handle._hatch_color = orig_handle._hatch_color
# Setters are fine for the remaining attributes.
legend_handle.set_linewidth(get_first(orig_handle.get_linewidths()))
legend_handle.set_linestyle(get_first(orig_handle.get_linestyles()))
legend_handle.set_transform(get_first(orig_handle.get_transforms()))
legend_handle.set_figure(orig_handle.get_figure())
legend_handle.set_alpha(orig_handle.get_alpha())
# Alpha is already taken into account by the color attributes.

def create_artists(self, legend, orig_handle,
xdescent, ydescent, width, height, fontsize, trans):
Expand Down
8 changes: 8 additions & 0 deletions lib/matplotlib/tests/test_legend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -765,3 +765,11 @@ def test_plot_multiple_label_incorrect_length_exception():
label = ['high', 'low', 'medium']
fig, ax = plt.subplots()
ax.plot(x, y, label=label)


def test_legend_face_edgecolor():
# Smoke test for PolyCollection legend handler with 'face' edgecolor.
fig, ax = plt.subplots()
ax.fill_between([0, 1, 2], [1, 2, 3], [2, 3, 4],
facecolor='r', edgecolor='face', label='Fill')
ax.legend()