Skip to content

Fix: Prevent Cursor blitting from erasing overlapping axes (#25670) #31368

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
QuLogic merged 6 commits into from
Mar 30, 2026
+26 −0
Merged

Fix: Prevent Cursor blitting from erasing overlapping axes (#25670) #31368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9faecaf
Fix: Prevent Cursor blitting from erasing overlapping axes
MohitPal2005 Mar 24, 2026
b39eaf1
Fix styling: remove trailing whitespace and shorten comment
MohitPal2005 Mar 24, 2026
d1f0a33
MAINT: explicitly mark Cursor blitting on overlapping axes as unsuppo…
MohitPal2005 Mar 29, 2026
1a29cbc
style: fix ruff line length limit in widgets.py
MohitPal2005 Mar 29, 2026
1098b05
test: add coverage for cursor overlapping axes warning
MohitPal2005 Mar 30, 2026
f2050ae
chore: trigger CI to clear Windows timeout flake
MohitPal2005 Mar 30, 2026
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
16 changes: 16 additions & 0 deletions lib/matplotlib/tests/test_widgets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1817,3 +1817,19 @@ def test_parent_axes_removal():
evt = DrawEvent('draw_event', fig.canvas, renderer)
radio._clear(evt)
checks._clear(evt)


def test_cursor_overlapping_axes_blitting_warning():
"""Test that a warning is raised and useblit is disabled for overlapping axes."""
fig = plt.figure()
ax1 = fig.add_axes([0.1, 0.1, 0.8, 0.8])
ax2 = fig.add_axes([0.2, 0.2, 0.6, 0.6]) # Explicitly overlaps ax1

match_text = (
"Cursor blitting is currently not supported on "
"overlapping axes"
)
with pytest.warns(UserWarning, match=match_text):
cursor = widgets.Cursor(ax1, useblit=True)

assert cursor.useblit is False
10 changes: 10 additions & 0 deletions lib/matplotlib/widgets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2084,6 +2084,16 @@ def __init__(self, ax, *, horizOn=True, vertOn=True, useblit=False,
self.vertOn = vertOn
self.useblit = useblit and self.canvas.supports_blit # TODO: make dynamic

if self.useblit:
for ax_ in ax.get_figure(root=True).get_axes():
if ax_ is not ax and ax.bbox.overlaps(ax_.bbox):
_api.warn_external(
"Cursor blitting is currently not supported on "
"overlapping axes; falling back to useblit=False."
)
self.useblit = False
break

if self.useblit:
lineprops['animated'] = True
self.lineh = ax.axhline(ax.get_ybound()[0], visible=False, **lineprops)
Expand Down
Loading