Skip to content

Fix boxplot legend entries part 2 #27711

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
Jan 31, 2024
Merged

Fix boxplot legend entries part 2 #27711

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
a62c25f
fix boxplot legend entries
saranti Dec 26, 2023
6ef9cce
improve test code
saranti Jan 31, 2024
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
7 changes: 7 additions & 0 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4004,6 +4004,9 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None,
if 'color' in boxprops:
boxprops['edgecolor'] = boxprops.pop('color')

if labels:
boxprops['label'] = labels

# if non-default sym value, put it into the flier dictionary
# the logic for providing the default symbol ('b+') now lives
# in bxp in the initial value of flierkw
Expand Down Expand Up @@ -4316,13 +4319,16 @@ def do_patch(xs, ys, **kwargs):
do_box = do_patch if patch_artist else do_plot
boxes.append(do_box(box_x, box_y, **box_kw))
# draw the whiskers
whisker_kw.setdefault('label', '_nolegend_')
whiskers.append(do_plot(whis_x, whislo_y, **whisker_kw))
whiskers.append(do_plot(whis_x, whishi_y, **whisker_kw))
# maybe draw the caps
if showcaps:
cap_kw.setdefault('label', '_nolegend_')
caps.append(do_plot(cap_x, cap_lo, **cap_kw))
caps.append(do_plot(cap_x, cap_hi, **cap_kw))
# draw the medians
median_kw.setdefault('label', '_nolegend_')
medians.append(do_plot(med_x, med_y, **median_kw))
# maybe draw the means
if showmeans:
Expand All @@ -4335,6 +4341,7 @@ def do_patch(xs, ys, **kwargs):
means.append(do_plot([pos], [stats['mean']], **mean_kw))
# maybe draw the fliers
if showfliers:
flier_kw.setdefault('label', '_nolegend_')
flier_x = np.full(len(stats['fliers']), pos, dtype=np.float64)
flier_y = stats['fliers']
fliers.append(do_plot(flier_x, flier_y, **flier_kw))
Expand Down
30 changes: 30 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 @@ -1427,3 +1427,33 @@ def test_legend_text():
leg_bboxes.append(
leg.get_window_extent().transformed(ax.transAxes.inverted()))
assert_allclose(leg_bboxes[1].bounds, leg_bboxes[0].bounds)


def test_boxplot_legend():
# Test that boxplot legends handles are patches
# and labels are generated from boxplot's labels parameter.
fig, axs = plt.subplots()
A = 5*np.random.rand(100, 1)
B = 10*np.random.rand(100, 1) - 5
C = 7*np.random.rand(100, 1) - 5
labels = ['a', 'b', 'c']

bp0 = axs.boxplot(A, positions=[0], patch_artist=True, labels=labels[0])
bp1 = axs.boxplot(B, positions=[1], patch_artist=True, labels=labels[1])
bp2 = axs.boxplot(C, positions=[2], patch_artist=True, labels=labels[2])
# red, blue, green
colors = [(1.0, 0.0, 0.0, 1), (0.0, 0.0, 1.0, 1), (0.0, 0.5, 0.0, 1)]
box_list = [bp0, bp1, bp2]
# Set colors to the boxes
lbl_index = 0
for b_plot, color in zip(box_list, colors):
for patch in b_plot['boxes']:
patch.set_color(color)
lbl_index += 1

legend = axs.legend()
for index, handle in enumerate(legend.legend_handles):
assert isinstance(handle, mpl.patches.Rectangle)
assert handle.get_facecolor() == colors[index]
assert handle.get_edgecolor() == colors[index]
assert handle.get_label() == labels[index]