ENH: add artist.inbbox boolean

jklymak · jklymak · commit d94858307c53 · 2018-04-28T19:01:51.000-07:00
diff --git a/lib/matplotlib/_constrained_layout.py b/lib/matplotlib/_constrained_layout.py
@@ -59,23 +59,6 @@
 _log = logging.getLogger(__name__)
 
 
-def get_axall_tightbbox(ax, renderer):
-    '''
-    Get the tight_bbox of the axis ax, and any dependent decorations, like
-    a `Legend` instance.
-    '''
-
-    # main bbox of the axis....
-    bbox = ax.get_tightbbox(renderer=renderer)
-    # now add the possibility of the legend...
-    for child in ax.get_children():
-        if isinstance(child, Legend):
-            bboxn = child._legend_box.get_window_extent(renderer)
-            bbox = transforms.Bbox.union([bbox, bboxn])
-        # add other children here....
-    return bbox
-
-
 def in_same_column(colnum0min, colnum0max, colnumCmin, colnumCmax):
     return (colnumCmin <= colnum0min <= colnumCmax
             or colnumCmin <= colnum0max <= colnumCmax)
@@ -203,7 +186,7 @@ def do_constrained_layout(fig, renderer, h_pad, w_pad,
         _log.debug(ax._layoutbox)
         if ax._layoutbox is not None:
             pos = ax.get_position(original=True)
-            tightbbox = get_axall_tightbbox(ax, renderer)
+            tightbbox = ax.get_tightbbox(renderer)
             bbox = invTransFig(tightbbox)
             # use stored h_pad if it exists
             h_padt = ax._poslayoutbox.h_pad
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -119,6 +119,7 @@ def __init__(self):
         self._sketch = rcParams['path.sketch']
         self._path_effects = rcParams['path.effects']
         self._sticky_edges = _XYPair([], [])
+        self.inbbox = True
 
     def __getstate__(self):
         d = self.__dict__.copy()
@@ -280,8 +281,7 @@ def get_tightbbox(self, renderer):
             clip_path = self.get_clip_path()
             if clip_path is not None and bbox is not None:
                 clip_path = clip_path.get_fully_transformed_path()
-                bbox = Bbox.intersection(bbox,
-                                         clip_path.get_extents())
+                bbox = Bbox.intersection(bbox, clip_path.get_extents())
         return bbox
 
     def add_callback(self, func):
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -4097,13 +4097,16 @@ def pick(self, *args):
 
     def get_default_bbox_extra_artists(self):
         return [artist for artist in self.get_children()
-                if artist.get_visible()]
+                if (artist.get_visible() and artist.inbbox)]
 
     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.
+        Return the tight bounding box of the axes, including axis and their
+        decorators (xlabel, title, etc).
+
+        Artists that have ``artist.inbbox=False`` are not included
+        in the bbox.  
 
         Parameters
         ----------
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1450,10 +1450,7 @@ def draw(self, renderer):
         try:
             renderer.open_group('figure')
             if self.get_constrained_layout() and self.axes:
-                if True:
-                    self.execute_constrained_layout(renderer)
-                else:
-                    pass
+                self.execute_constrained_layout(renderer)
             if self.get_tight_layout() and self.axes:
                 try:
                     self.tight_layout(renderer,
@@ -1993,7 +1990,7 @@ def waitforbuttonpress(self, timeout=-1):
 
     def get_default_bbox_extra_artists(self):
         bbox_artists = [artist for artist in self.get_children()
-                        if artist.get_visible()]
+                        if (artist.get_visible() and artist.inbbox)]
         for ax in self.axes:
             if ax.get_visible():
                 bbox_artists.extend(ax.get_default_bbox_extra_artists())
@@ -2027,6 +2024,7 @@ def get_tightbbox(self, renderer, bbox_extra_artists=None):
             artists = self.get_default_bbox_extra_artists()
         else:
             artists = bbox_extra_artists
+
         for a in artists:
             bbox = a.get_tightbbox(renderer)
             if bbox is not None and (bbox.width != 0 or bbox.height != 0):
