ENH have ax.get_tightbbox have a bbox around all artists

jklymak · jklymak · commit 6e60ecf10ec4 · 2018-07-05T14:30:33.000-07:00
diff --git a/doc/api/next_api_changes/2018-04-29-JMK.rst b/doc/api/next_api_changes/2018-04-29-JMK.rst
@@ -8,14 +8,13 @@ a figure and adjust spacing between axes.
 
 In Matplotlib 2.2 ``get_tightbbox`` started to include legends made on the
 axes, but still excluded some other artists, like text that may overspill an
-axes.  For Matplotlib 3.0, *all* artists are not included in the bounding box.
+axes.  For Matplotlib 3.0, *all* artists are now included in the bounding box.
 
-However, it is sometimes undesirable to include an artist in the bounding box
-of the axes.  There are two ways of dealing with this.  The *most* desiable
-is to make the artist a child of the figure, not the axes.  i.e. calling
-``fig.legend`` instead of ``ax.legend`` (perhaps using
-`~.matplotlib.Axes.get_legend_handles_labels` to gather handles and labels
-from the parent axes).
+This new default may be overridden in either of two ways:
 
-The second way is to set the artist property ``artist.set_in_layout(False)``
-to make the artist not be included in the bounding box calculation.
+1) Make the artist to be excluded a child of the figure, not the axes. E.g.,
+  call `fig.legend()`` instead of ``ax.legend()`` (perhaps using
+  `~.matplotlib.Axes.get_legend_handles_labels` to gather handles and labels
+  from the parent axes).
+2) If the artist is a child of the axes, set the artist property
+    ``artist.set_in_layout(False)``.
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -740,9 +740,12 @@ def get_animated(self):
 
     def get_in_layout(self):
         """
-        Return if artist is to be included in layout calculations
-        like `.Figure.tight_layout` and constrained layout.  Also
-        for ``fig.savefig(fname, bbox_inches='tight')``.
+        Return boolean flag, ``True`` if artist is included in layout
+        calculations.
+
+        E.g. :doc:`/tutorials/intermediate/constrained_layout`,
+        `.Figure.tight_layout()`, and
+        ``fig.savefig(fname, bbox_inches='tight')``.
         """
         return self._in_layout
 
@@ -883,9 +886,10 @@ def set_animated(self, b):
 
     def set_in_layout(self, in_layout):
         """
-        Set if artist is to be included in layout calculations
-        like `.Figure.tight_layout` and constrained layout.  Also
-        for ``fig.savefig(fname, bbox_inches='tight')```.
+        Set if artist is to be included in layout calculations,
+        E.g. :doc:`/tutorials/intermediate/constrained_layout`,
+        `.Figure.tight_layout()`, and
+        ``fig.savefig(fname, bbox_inches='tight')``.
 
         Parameters
         ----------
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -4110,8 +4110,10 @@ def pick(self, *args):
     def get_default_bbox_extra_artists(self):
         """
         Return a default list of artists that are used for the bounding box
-        calculation.  Artists are excluded either by not being visible
-        or ``artist.set_in_layout(False)``.
+        calculation.
+
+        Artists are excluded either by not being visible or
+        ``artist.set_in_layout(False)``.
         """
         return [artist for artist in self.get_children()
                 if (artist.get_visible() and artist.get_in_layout())]
@@ -4146,7 +4148,7 @@ def get_tightbbox(self, renderer, call_axes_locator=True,
         Returns
         -------
         bbox : `.BboxBase`
-            containing the bounding box (in figure pixel co-ordinates).
+            bounding box in figure pixel coordinates.
         """
 
         bb = []
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -2017,7 +2017,7 @@ def get_tightbbox(self, renderer, bbox_extra_artists=None):
         """
         Return a (tight) bounding box of the figure in inches.
 
-        Artists that have ``artist.inbbox = False`` are not included
+        Artists that have ``artist.set_in_layout(False)`` are not included
         in the bbox.
 
         Parameters
@@ -2104,7 +2104,7 @@ def tight_layout(self, renderer=None, pad=1.08, h_pad=None, w_pad=None,
 
         To exclude an artist on the axes from the bounding box calculation
         that determines the subplot parameters (i.e. legend, or annotation),
-        then set `a.inbbox=False` for that artist.
+        then set `a.set_in_layout(False)` for that artist.
 
         Parameters
         ----------
diff --git a/lib/matplotlib/legend.py b/lib/matplotlib/legend.py
@@ -992,25 +992,7 @@ def get_tightbbox(self, renderer):
 
         Returns
         -------
-        `.BboxBase` : containing the bounding box (in figure-relative
-            co-ordinates).
-        """
-        return self._legend_box.get_window_extent(renderer)
-
-    def get_tightbbox(self, renderer):
-        """
-        Like `.Legend.get_window_extent`, but uses the box for the legend.
-
-        Parameters
-        ----------
-        renderer : `.RendererBase` instance
-            renderer that will be used to draw the figures (i.e.
-            ``fig.canvas.get_renderer()``)
-
-        Returns
-        -------
-        `.BboxBase` : containing the bounding box (in figure-relative
-            co-ordinates).
+        `.BboxBase` : containing the bounding box in figure pixel co-ordinates.
         """
         return self._legend_box.get_window_extent(renderer)
 
