Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Disable QuadMesh cursor data by default #22254

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 1 commit into from
Jan 20, 2022
Merged

Disable QuadMesh cursor data by default #22254

Show file tree
Hide file tree
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
5 changes: 5 additions & 0 deletions doc/api/next_api_changes/behavior/22254-DS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
QuadMesh cursor data disabled by default
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Showing the cursor data of a `.QuadMesh` is now disabled by default, as it has
significant performance issues with large meshes. To manually enable this
use :meth:`.QuadMesh.set_show_cursor_data`.
17 changes: 17 additions & 0 deletions lib/matplotlib/collections.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2000,6 +2000,7 @@ def __init__(self, *args, **kwargs):
self._shading = shading
self._bbox = transforms.Bbox.unit()
self._bbox.update_from_data_xy(self._coordinates.reshape(-1, 2))
self._show_cursor_data = False
# super init delayed after own init because array kwarg requires
# self._coordinates and self._shading
super().__init__(**kwargs)
Expand Down Expand Up @@ -2197,7 +2198,23 @@ def draw(self, renderer):
renderer.close_group(self.__class__.__name__)
self.stale = False

def set_show_cursor_data(self, show_cursor_data):
"""
Set whether cursor data should be shown.

Notes
-----
This is set to `False` by default for new quad meshes. Showing cursor
data can have significant performance impacts for large meshes.
"""
self._show_cursor_data = show_cursor_data

def get_show_cursor_data(self):
return self._show_cursor_data

def get_cursor_data(self, event):
if not self._show_cursor_data:
return
contained, info = self.contains(event)
if len(info["ind"]) == 1:
ind, = info["ind"]
Expand Down
15 changes: 11 additions & 4 deletions lib/matplotlib/tests/test_collections.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1027,13 +1027,20 @@ def test_quadmesh_cursor_data():
fig, ax = plt.subplots()
*_, qm = ax.hist2d(
np.arange(11)**2, 100 + np.arange(11)**2) # width-10 bins

x, y = ax.transData.transform([1, 101])
event = MouseEvent('motion_notify_event', fig.canvas, x, y)

assert qm.get_show_cursor_data() is False
assert qm.get_cursor_data(event) is None

qm.set_show_cursor_data(True)
assert qm.get_cursor_data(event) == 4 # (0**2, 1**2, 2**2, 3**2)
for out_xydata in []:
x, y = ax.transData.transform([-1, 101])
event = MouseEvent('motion_notify_event', fig.canvas, x, y)
assert qm.get_cursor_data(event) is None

# Outside the quadmesh bounds
x, y = ax.transData.transform([-1, 101])
event = MouseEvent('motion_notify_event', fig.canvas, x, y)
assert qm.get_cursor_data(event) is None


def test_get_segments():
Expand Down