8000 Add inaxes method to FigureCanvas to check whether point is in an axes. by lkjell · Pull Request #9845 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]

Skip to content

Add inaxes method to FigureCanvas to check whether point is in an axes. #9845

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.

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 6 commits into from
Feb 10, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions doc/users/next_whats_new/2017-11-24_figurecanvas_inaxes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

Add ``inaxes`` method to FigureCanvas
-------------------------------------------------------------

The `FigureCanvas` class has now an ``inaxes`` method to check whether a point is in an axes
and returns the topmost axes, else None.
44 changes: 36 additions & 8 deletions lib/matplotlib/backend_bases.py
Original file line number Diff line number Diff line change
Expand Up @@ -1496,15 +1496,12 @@ def __init__(self, name, canvas, x, y, guiEvent=None):
self._update_enter_leave()
return

# Find all axes containing the mouse
if self.canvas.mouse_grabber is None:
axes_list = [a for a in self.canvas.figure.get_axes()
if a.in_axes(self)]
self.inaxes = self.canvas.inaxes((x, y))
else:
axes_list = [self.canvas.mouse_grabber]
self.inaxes = self.canvas.mouse_grabber

if axes_list:
self.inaxes = cbook._topmost_artist(axes_list)
if self.inaxes is not None:
try:
trans = self.inaxes.transData.inverted()
xdata, ydata = trans.transform_point((x, y))
Expand All @@ -1514,8 +1511,6 @@ def __init__(self, name, canvas, x, y, guiEvent=None):
else:
self.xdata = xdata
self.ydata = ydata
else:
self.inaxes = None

self._update_enter_leave()

Expand Down Expand Up @@ -1993,6 +1988,39 @@ def enter_notify_event(self, guiEvent=None, xy=None):
event = LocationEvent('figure_enter_event', self, x, y, guiEvent)
self.callbacks.process('figure_enter_event', event)

@cbook.deprecated("2.1")
def idle_event(self, guiEvent=None):
"""Called when GUI is idle."""
s = 'idle_event'
event = IdleEvent(s, self, guiEvent=guiEvent)
self.callbacks.process(s, event)

def inaxes(self, xy):
"""
Check if a point is in an axes.

Parameters
----------
xy : tuple or list
(x,y) coordinates.
x position - pixels from left of canvas.
y position - pixels from bottom of canvas.

Returns
-------
axes: topmost axes containing the point, or None if no axes.

"""
axes_list = [a for a in self.figure.get_axes()
if a.patch.contains_point(xy)]

if axes_list:
axes = cbook._topmost_artist(axes_list)
else:
axes = None

return axes

def grab_mouse(self, ax):
"""
Set the child axes which are currently grabbing the mouse events.
Expand Down
0