Implement get_cursor_data for QuadMesh.

anntzer · anntzer · commit 0cca1de6f15c · 2021-04-08T19:08:21.000+02:00
The motivation is actually to provide get_cursor_data for hist2d, which
uses a QuadMesh to draw itself (see the test).

As it turns out, Collection.contains already contains the relevant code
to find which path contains the mouse event, so just reuse that.
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -1262,19 +1262,33 @@ def format_cursor_data(self, data):
             method yourself.
 
         The default implementation converts ints and floats and arrays of ints
-        and floats into a comma-separated string enclosed in square brackets.
+        and floats into a comma-separated string enclosed in square brackets,
+        unless the artist has an associated colorbar, in which case scalar
+        values are formatted using the colorbar's formatter.
 
         See Also
         --------
         get_cursor_data
         """
-        try:
-            data[0]
-        except (TypeError, IndexError):
-            data = [data]
-        data_str = ', '.join('{:0.3g}'.format(item) for item in data
-                             if isinstance(item, Number))
-        return "[" + data_str + "]"
+        if np.ndim(data) == 0 and getattr(self, "colorbar", None):
+            # This block logically belongs to ScalarMappable, but can't be
+            # implemented in it because most ScalarMappable subclasses inherit
+            # from Artist first and from ScalarMappable second, so
+            # Artist.format_cursor_data would always have precedence over
+            # ScalarMappable.format_cursor_data.
+            return (
+                "["
+                + cbook.strip_math(
+                    self.colorbar.formatter.format_data_short(data)).strip()
+                + "]")
+        else:
+            try:
+                data[0]
+            except (TypeError, IndexError):
+                data = [data]
+            data_str = ', '.join('{:0.3g}'.format(item) for item in data
+                                 if isinstance(item, Number))
+            return "[" + data_str + "]"
 
     @property
     def mouseover(self):
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -1961,7 +1961,7 @@ def draw(self, renderer):
 
 
 class QuadMesh(Collection):
-    """
+    r"""
     Class for the efficient drawing of a quadrilateral mesh.
 
     A quadrilateral mesh consists of a grid of vertices.
@@ -1987,11 +1987,16 @@ class QuadMesh(Collection):
     vertex at mesh coordinates (0, 0), then the one at (0, 1), then at (0, 2)
     .. (0, meshWidth), (1, 0), (1, 1), and so on.
 
-    *shading* may be 'flat', or 'gouraud'
+    *shading* may be 'flat', or 'gouraud'.
+
+    Unlike other `.Collection`\s, the default *pickradius* of `.QuadMesh` is 0,
+    i.e. `~.Artist.contains` checks whether the test point is within any of the
+    mesh quadrilaterals.
     """
+
     def __init__(self, meshWidth, meshHeight, coordinates,
-                 antialiased=True, shading='flat', **kwargs):
-        super().__init__(**kwargs)
+                 antialiased=True, shading='flat', *, pickradius=0, **kwargs):
+        super().__init__(pickradius=pickradius, **kwargs)
         self._meshWidth = meshWidth
         self._meshHeight = meshHeight
         # By converting to floats now, we can avoid that on every draw.
@@ -2131,6 +2136,14 @@ def draw(self, renderer):
         renderer.close_group(self.__class__.__name__)
         self.stale = False
 
+    def get_cursor_data(self, event):
+        contained, info = self.contains(event)
+        if len(info["ind"]) == 1:
+            ind, = info["ind"]
+            return self.get_array()[ind]
+        else:
+            return None
+
 
 _artist_kwdoc = artist.kwdoc(Collection)
 for k in ('QuadMesh', 'TriMesh', 'PolyCollection', 'BrokenBarHCollection',
diff --git a/lib/matplotlib/image.py b/lib/matplotlib/image.py
@@ -997,16 +997,6 @@ def get_cursor_data(self, event):
         else:
             return arr[i, j]
 
-    def format_cursor_data(self, data):
-        if np.ndim(data) == 0 and self.colorbar:
-            return (
-                "["
-                + cbook.strip_math(
-                    self.colorbar.formatter.format_data_short(data)).strip()
-                + "]")
-        else:
-            return super().format_cursor_data(data)
-
 
 class NonUniformImage(AxesImage):
     mouseover = False  # This class still needs its own get_cursor_data impl.
diff --git a/lib/matplotlib/tests/test_collections.py b/lib/matplotlib/tests/test_collections.py
@@ -7,6 +7,7 @@
 
 import matplotlib as mpl
 import matplotlib.pyplot as plt
+from matplotlib.backend_bases import MouseEvent
 import matplotlib.collections as mcollections
 import matplotlib.colors as mcolors
 import matplotlib.transforms as mtransforms
@@ -884,3 +885,16 @@ def test_array_wrong_dimensions():
     pc = plt.pcolormesh(z)
     pc.set_array(z)  # 2D is OK for Quadmesh
     pc.update_scalarmappable()
+
+
+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_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
