Skip to content

Add HandlerPatchCollection to support legends for PatchCollection #29952

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

Closed
anika3943 wants to merge 1 commit into from
Closed

Add HandlerPatchCollection to support legends for PatchCollection #29952

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
39 changes: 39 additions & 0 deletions lib/matplotlib/legend_handler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -810,3 +810,42 @@ def create_artists(self, legend, orig_handle,
self.update_prop(p, orig_handle, legend)
p.set_transform(trans)
return [p]

from matplotlib.legend_handler import HandlerPatchCollection

@rcomer rcomer Apr 21, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This module is legend_handler, so you do not need to import from it.


_default_handler_map[PatchCollection] = HandlerPatchCollection()


from matplotlib.patches import Patch
from matplotlib.collections import PatchCollection

class HandlerPatchCollection(HandlerPatch):
"""
Handler for PatchCollection, e.g. from matplotlib.collections.
Uses the properties of the first patch in the collection.
"""

def create_artists(self, legend, orig_handle,
xdescent, ydescent, width, height, fontsize, trans):
p = Patch()

try:
fc = orig_handle.get_facecolor()[0]
ec = orig_handle.get_edgecolor()[0]
lw = orig_handle.get_linewidths()[0]
ls = orig_handle.get_linestyle()[0]
except IndexError:
fc, ec, lw, ls = 'gray', 'black', 1.0, 'solid'

p.set_facecolor(fc)
p.set_edgecolor(ec)
p.set_linewidth(lw)
p.set_linestyle(ls)

self.update_prop(p, orig_handle, legend)
p.set_transform(trans)
p.set_xy([[-xdescent, -ydescent],
[-xdescent + width, -ydescent],
[-xdescent + width, -ydescent + height],
[-xdescent, -ydescent + height]])
return [p]