ENH have ax.get_tightbbox have a bbox around all artists

jklymak · jklymak · commit 3159d8b875ad · 2018-04-28T19:01:50.000-07:00
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -4099,16 +4099,33 @@ def get_default_bbox_extra_artists(self):
         return [artist for artist in self.get_children()
                 if artist.get_visible()]
 
-    def get_tightbbox(self, renderer, call_axes_locator=True):
+    def get_tightbbox(self, renderer, call_axes_locator=True,
+            bbox_extra_artists=None):
         """
         Return the tight bounding box of the axes.
         The dimension of the Bbox in canvas coordinate.
 
-        If *call_axes_locator* is *False*, it does not call the
-        _axes_locator attribute, which is necessary to get the correct
-        bounding box. ``call_axes_locator==False`` can be used if the
-        caller is only intereted in the relative size of the tightbbox
-        compared to the axes bbox.
+        Parameters
+        ----------
+        renderer : RendererBase instance
+            renderer that will be used to draw the figures (i.e.
+            ``fig.canvas.get_renderer()``)
+
+        bbox_extra_artists : list of `Artist` or ``None``
+            List of artists to include in the tight bounding box.  If
+            ``None`` (default), then all artist children of the axes are
+            included in the tight bounding box.
+
+        call_axes_locator : boolean (default ``True``)
+            If *call_axes_locator* is ``False``, it does not call the
+            ``_axes_locator`` attribute, which is necessary to get the correct
+            bounding box. ``call_axes_locator=False`` can be used if the
+            caller is only interested in the relative size of the tightbbox
+            compared to the axes bbox.
+
+        Returns
+        -------
+        `BboxBase` : containing the bounding box (in relative co-ordinates).
         """
 
         bb = []
@@ -4142,11 +4159,27 @@ def get_tightbbox(self, renderer, call_axes_locator=True):
         if bb_yaxis:
             bb.append(bb_yaxis)
 
-        for child in self.get_children():
-            if isinstance(child, OffsetBox) and child.get_visible():
-                bb.append(child.get_window_extent(renderer))
-            elif isinstance(child, Legend) and child.get_visible():
-                bb.append(child._legend_box.get_window_extent(renderer))
+        bbox_artists = bbox_extra_artists
+        if bbox_artists is None:
+            bbox_artists = self.get_default_bbox_extra_artists()
+
+        for a in bbox_artists:
+            if isinstance(a, Legend) and a.get_visible():
+                bb.append(a._legend_box.get_window_extent(renderer))
+            else:
+                bbox = a.get_window_extent(renderer)
+                if a.get_clip_on():
+                    clip_box = a.get_clip_box()
+                    if clip_box is not None:
+                        bbox = mtransforms.Bbox.intersection(bbox, clip_box)
+                    clip_path = a.get_clip_path()
+                    if clip_path is not None and bbox is not None:
+                        clip_path = clip_path.get_fully_transformed_path()
+                        bbox = mtransforms.Bbox.intersection(bbox,
+                                                 clip_path.get_extents())
+                if bbox is not None and (bbox.width != 0 or
+                                         bbox.height != 0):
+                    bb.append(bbox)
 
         _bbox = mtransforms.Bbox.union(
             [b for b in bb if b.width != 0 or b.height != 0])
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -2001,18 +2001,31 @@ def get_default_bbox_extra_artists(self):
         bbox_artists.remove(self.patch)
         return bbox_artists
 
-    def get_tightbbox(self, renderer):
+    def get_tightbbox(self, renderer, bbox_extra_artists=None):
         """
         Return a (tight) bounding box of the figure in inches.
 
-        Currently, this takes only axes title, axis labels, and axis
-        ticklabels into account. Needs improvement.
+        Parameters
+        ----------
+        renderer : RendererBase instance
+            renderer that will be used to draw the figures (i.e.
+            ``fig.canvas.get_renderer()``)
+
+        bbox_extra_artists : list of `Artist` or ``None``
+            List of artists to include in the tight bounding box.  If
+            ``None`` (default), then all artist children of each axes are
+            included in the tight bounding box.
+
+        Returns
+        -------
+        `BboxBase` : containing the bounding box (in figure co-ordinates).
         """
 
-        bb = []
+        bb = [artist for artist in self.get_children()
+                        if artist.get_visible()]
         for ax in self.axes:
             if ax.get_visible():
-                bb.append(ax.get_tightbbox(renderer))
+                bb.append(ax.get_tightbbox(renderer, bbox_extra_artists))
 
         if len(bb) == 0:
             return self.bbox_inches
