Get dpi, canvas and renderer directly from the root Figure

Co-authored-by: Thomas A Caswell <tcaswell@gmail.com>

Author: rcomer

lib/matplotlib/artist.py

@@ -474,7 +474,7 @@ def _different_canvas(self, event):
             # subclass-specific implementation follows
         """
         return (getattr(event, "canvas", None) is not None
-                and (fig := self.get_figure(root=False)) is not None
+                and (fig := self.get_figure(root=True)) is not None
                 and event.canvas is not fig.canvas)
 
     def contains(self, mouseevent):
@@ -527,7 +527,7 @@ def pick(self, mouseevent):
             else:
                 inside, prop = self.contains(mouseevent)
             if inside:
-                PickEvent("pick_event", self.get_figure(root=False).canvas,
+                PickEvent("pick_event", self.get_figure(root=True).canvas,
                           mouseevent, self, **prop)._process()
 
         # Pick children

lib/matplotlib/axes/_base.py

@@ -3113,7 +3113,7 @@ def draw(self, renderer):
             for _axis in self._axis_map.values():
                 artists.remove(_axis)
 
-        if not self.get_figure(root=False).canvas.is_saving():
+        if not self.get_figure(root=True).canvas.is_saving():
             artists = [
                 a for a in artists
                 if not a.get_animated() or isinstance(a, mimage.AxesImage)]
@@ -3153,7 +3153,7 @@ def draw_artist(self, a):
         """
         Efficiently redraw a single artist.
         """
-        a.draw(self.get_figure(root=False).canvas.get_renderer())
+        a.draw(self.get_figure(root=True).canvas.get_renderer())
 
     def redraw_in_frame(self):
         """
@@ -3163,7 +3163,7 @@ def redraw_in_frame(self):
             for artist in [*self._axis_map.values(),
                            self.title, self._left_title, self._right_title]:
                 stack.enter_context(artist._cm_set(visible=False))
-            self.draw(self.get_figure(root=False).canvas.get_renderer())
+            self.draw(self.get_figure(root=True).canvas.get_renderer())
 
     # Axes rectangle characteristics
 
@@ -4471,7 +4471,7 @@ def get_tightbbox(self, renderer=None, call_axes_locator=True,
 
         bb = []
         if renderer is None:
-            renderer = self.get_figure(root=False)._get_renderer()
+            renderer = self.get_figure(root=True)._get_renderer()
 
         if not self.get_visible():
             return None

lib/matplotlib/axis.py

@@ -1347,7 +1347,7 @@ def _update_ticks(self):
     def _get_ticklabel_bboxes(self, ticks, renderer=None):
         """Return lists of bboxes for ticks' label1's and label2's."""
         if renderer is None:
-            renderer = self.get_figure(root=False)._get_renderer()
+            renderer = self.get_figure(root=True)._get_renderer()
         return ([tick.label1.get_window_extent(renderer)
                  for tick in ticks if tick.label1.get_visible()],
                 [tick.label2.get_window_extent(renderer)
@@ -1366,7 +1366,7 @@ def get_tightbbox(self, renderer=None, *, for_layout_only=False):
         if not self.get_visible():
             return
         if renderer is None:
-            renderer = self.get_figure(root=False)._get_renderer()
+            renderer = self.get_figure(root=True)._get_renderer()
         ticks_to_draw = self._update_ticks()
 
         self._update_label_position(renderer)
@@ -2410,13 +2410,13 @@ def _update_label_position(self, renderer):
             bbox = mtransforms.Bbox.union([
                 *bboxes, self.axes.spines.get("bottom", self.axes).get_window_extent()])
             self.label.set_position(
-                (x, bbox.y0 - self.labelpad * self.get_figure(root=False).dpi / 72))
+                (x, bbox.y0 - self.labelpad * self.get_figure(root=True).dpi / 72))
         else:
             # Union with extents of the top spine if present, of the axes otherwise.
             bbox = mtransforms.Bbox.union([
                 *bboxes2, self.axes.spines.get("top", self.axes).get_window_extent()])
             self.label.set_position(
-                (x, bbox.y1 + self.labelpad * self.get_figure(root=False).dpi / 72))
+                (x, bbox.y1 + self.labelpad * self.get_figure(root=True).dpi / 72))
 
     def _update_offset_text_position(self, bboxes, bboxes2):
         """
@@ -2432,14 +2432,14 @@ def _update_offset_text_position(self, bboxes, bboxes2):
             else:
                 bbox = mtransforms.Bbox.union(bboxes)
                 bottom = bbox.y0
-            y = bottom - self.OFFSETTEXTPAD * self.get_figure(root=False).dpi / 72
+            y = bottom - self.OFFSETTEXTPAD * self.get_figure(root=True).dpi / 72
         else:
             if not len(bboxes2):
                 top = self.axes.bbox.ymax
             else:
                 bbox = mtransforms.Bbox.union(bboxes2)
                 top = bbox.y1
-            y = top + self.OFFSETTEXTPAD * self.get_figure(root=False).dpi / 72
+            y = top + self.OFFSETTEXTPAD * self.get_figure(root=True).dpi / 72
         self.offsetText.set_position((x, y))
 
     def set_ticks_position(self, position):
@@ -2637,13 +2637,13 @@ def _update_label_position(self, renderer):
             bbox = mtransforms.Bbox.union([
                 *bboxes, self.axes.spines.get("left", self.axes).get_window_extent()])
             self.label.set_position(
-                (bbox.x0 - self.labelpad * self.get_figure(root=False).dpi / 72, y))
+                (bbox.x0 - self.labelpad * self.get_figure(root=True).dpi / 72, y))
         else:
             # Union with extents of the right spine if present, of the axes otherwise.
             bbox = mtransforms.Bbox.union([
                 *bboxes2, self.axes.spines.get("right", self.axes).get_window_extent()])
             self.label.set_position(
-                (bbox.x1 + self.labelpad * self.get_figure(root=False).dpi / 72, y))
+                (bbox.x1 + self.labelpad * self.get_figure(root=True).dpi / 72, y))
 
     def _update_offset_text_position(self, bboxes, bboxes2):
         """
@@ -2658,7 +2658,7 @@ def _update_offset_text_position(self, bboxes, bboxes2):
             bbox = self.axes.bbox
         top = bbox.ymax
         self.offsetText.set_position(
-            (x, top + self.OFFSETTEXTPAD * self.get_figure(root=False).dpi / 72)
+            (x, top + self.OFFSETTEXTPAD * self.get_figure(root=True).dpi / 72)
         )
 
     def set_offset_position(self, position):

lib/matplotlib/backend_bases.py

@@ -1514,7 +1514,7 @@ def _mouse_handler(event):
                 # done with the internal _set_inaxes method which ensures that
                 # the xdata and ydata attributes are also correct.
                 try:
-                    canvas = last_axes.get_figure(root=False).canvas
+                    canvas = last_axes.get_figure(root=True).canvas
                     leave_event = LocationEvent(
                         "axes_leave_event", canvas,
                         event.x, event.y, event.guiEvent,
@@ -2496,27 +2496,27 @@ def _get_uniform_gridstate(ticks):
         scale = ax.get_yscale()
         if scale == 'log':
             ax.set_yscale('linear')
-            ax.get_figure(root=False).canvas.draw_idle()
+            ax.get_figure(root=True).canvas.draw_idle()
         elif scale == 'linear':
             try:
                 ax.set_yscale('log')
             except ValueError as exc:
                 _log.warning(str(exc))
                 ax.set_yscale('linear')
-            ax.get_figure(root=False).canvas.draw_idle()
+            ax.get_figure(root=True).canvas.draw_idle()
     # toggle scaling of x-axes between 'log and 'linear' (default key 'k')
     elif event.key in rcParams['keymap.xscale']:
         scalex = ax.get_xscale()
         if scalex == 'log':
             ax.set_xscale('linear')
-            ax.get_figure(root=False).canvas.draw_idle()
+            ax.get_figure(root=True).canvas.draw_idle()
         elif scalex == 'linear':
             try:
                 ax.set_xscale('log')
             except ValueError as exc:
                 _log.warning(str(exc))
                 ax.set_xscale('linear')
-            ax.get_figure(root=False).canvas.draw_idle()
+            ax.get_figure(root=True).canvas.draw_idle()
 
 
 def button_press_handler(event, canvas=None, toolbar=None):

lib/matplotlib/collections.py

@@ -1001,7 +1001,7 @@ def set_sizes(self, sizes, dpi=72.0):
 
     @artist.allow_rasterization
     def draw(self, renderer):
-        self.set_sizes(self._sizes, self.get_figure(root=False).dpi)
+        self.set_sizes(self._sizes, self.get_figure(root=True).dpi)
         super().draw(renderer)
 
 
@@ -1310,7 +1310,7 @@ def get_rotation(self):
 
     @artist.allow_rasterization
     def draw(self, renderer):
-        self.set_sizes(self._sizes, self.get_figure(root=False).dpi)
+        self.set_sizes(self._sizes, self.get_figure(root=True).dpi)
         self._transforms = [
             transforms.Affine2D(x).rotate(-self._rotation).get_matrix()
             for x in self._transforms

lib/matplotlib/contour.py

@@ -27,7 +27,7 @@
 
 
 def _contour_labeler_event_handler(cs, inline, inline_spacing, event):
-    canvas = cs.axes.get_figure(root=False).canvas
+    canvas = cs.axes.get_figure(root=True).canvas
     is_button = event.name == "button_press_event"
     is_key = event.name == "key_press_event"
     # Quit (even if not in infinite mode; this is consistent with
@@ -224,7 +224,7 @@ def too_close(self, x, y, lw):
     def _get_nth_label_width(self, nth):
         """Return the width of the *nth* label, in pixels."""
         fig = self.axes.get_figure(root=False)
-        renderer = fig._get_renderer()
+        renderer = fig.get_figure(root=True)._get_renderer()
         return (Text(0, 0,
                      self.get_text(self.labelLevelList[nth], self.labelFmt),
                      figure=fig, fontproperties=self._label_font_props)

lib/matplotlib/figure.py

@@ -947,7 +947,7 @@ def _remove_axes(self, ax, owners):
 
         self._axobservers.process("_axes_change_event", self)
         self.stale = True
-        self.canvas.release_mouse(ax)
+        self._root_figure.canvas.release_mouse(ax)
 
         for name in ax._axis_names:  # Break link between any shared Axes
             grouper = ax._shared_axes[name]

lib/matplotlib/legend.py

@@ -1065,7 +1065,7 @@ def get_title(self):
     def get_window_extent(self, renderer=None):
         # docstring inherited
         if renderer is None:
-            renderer = self.get_figure(root=False)._get_renderer()
+            renderer = self.get_figure(root=True)._get_renderer()
         return self._legend_box.get_window_extent(renderer=renderer)
 
     def get_tightbbox(self, renderer=None):

lib/matplotlib/lines.py

@@ -467,7 +467,7 @@ def contains(self, mouseevent):
         yt = xy[:, 1]
 
         # Convert pick radius from points to pixels
-        fig = self.get_figure(root=False)
+        fig = self.get_figure(root=True)
         if fig is None:
             _log.warning('no figure set when check if mouse is on line')
             pixels = self._pickradius
@@ -641,7 +641,7 @@ def get_window_extent(self, renderer=None):
                                  ignore=True)
         # correct for marker size, if any
         if self._marker:
-            ms = (self._markersize / 72.0 * self.get_figure(root=False).dpi) * 0.5
+            ms = (self._markersize / 72.0 * self.get_figure(root=True).dpi) * 0.5
             bbox = bbox.padded(ms)
         return bbox
 
@@ -1649,7 +1649,7 @@ def __init__(self, line):
             'pick_event', self.onpick)
         self.ind = set()
 
-    canvas = property(lambda self: self.axes.get_figure(root=False).canvas)
+    canvas = property(lambda self: self.axes.get_figure(root=True).canvas)
 
     def process_selected(self, ind, xs, ys):
         """

lib/matplotlib/offsetbox.py

@@ -363,7 +363,7 @@ def get_bbox(self, renderer):
     def get_window_extent(self, renderer=None):
         # docstring inherited
         if renderer is None:
-            renderer = self.get_figure(root=False)._get_renderer()
+            renderer = self.get_figure(root=True)._get_renderer()
         bbox = self.get_bbox(renderer)
         try:  # Some subclasses redefine get_offset to take no args.
             px, py = self.get_offset(bbox, renderer)
@@ -1356,15 +1356,15 @@ def get_fontsize(self):
     def get_window_extent(self, renderer=None):
         # docstring inherited
         if renderer is None:
-            renderer = self.get_figure(root=False)._get_renderer()
+            renderer = self.get_figure(root=True)._get_renderer()
         self.update_positions(renderer)
         return Bbox.union([child.get_window_extent(renderer)
                            for child in self.get_children()])
 
     def get_tightbbox(self, renderer=None):
         # docstring inherited
         if renderer is None:
-            renderer = self.get_figure(root=False)._get_renderer()
+            renderer = self.get_figure(root=True)._get_renderer()
         self.update_positions(renderer)
         return Bbox.union([child.get_tightbbox(renderer)
                            for child in self.get_children()])
@@ -1469,7 +1469,7 @@ def __init__(self, ref_artist, use_blit=False):
         ]
 
     # A property, not an attribute, to maintain picklability.
-    canvas = property(lambda self: self.ref_artist.get_figure(root=False).canvas)
+    canvas = property(lambda self: self.ref_artist.get_figure(root=True).canvas)
     cids = property(lambda self: [
         disconnect.args[0] for disconnect in self._disconnectors[:2]])
 
@@ -1481,7 +1481,7 @@ def on_motion(self, evt):
             if self._use_blit:
                 self.canvas.restore_region(self.background)
                 self.ref_artist.draw(
-                    self.ref_artist.get_figure(root=False)._get_renderer())
+                    self.ref_artist.get_figure(root=True)._get_renderer())
                 self.canvas.blit()
             else:
                 self.canvas.draw()
@@ -1536,7 +1536,7 @@ def __init__(self, ref_artist, offsetbox, use_blit=False):
 
     def save_offset(self):
         offsetbox = self.offsetbox
-        renderer = offsetbox.get_figure(root=False)._get_renderer()
+        renderer = offsetbox.get_figure(root=True)._get_renderer()
         offset = offsetbox.get_offset(offsetbox.get_bbox(renderer), renderer)
         self.offsetbox_x, self.offsetbox_y = offset
         self.offsetbox.set_offset(offset)
@@ -1547,7 +1547,7 @@ def update_offset(self, dx, dy):
 
     def get_loc_in_canvas(self):
         offsetbox = self.offsetbox
-        renderer = offsetbox.get_figure(root=False)._get_renderer()
+        renderer = offsetbox.get_figure(root=True)._get_renderer()
         bbox = offsetbox.get_bbox(renderer)
         ox, oy = offsetbox._offset
         loc_in_canvas = (ox + bbox.x0, oy + bbox.y0)