windowextent-for-annotationbbox

ImportanceOfBeingErnest · ImportanceOfBeingErnest · commit 6773da4d8a42 · 2019-02-23T00:36:15.000+01:00
diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py
@@ -1494,6 +1494,24 @@ def get_fontsize(self, s=None):
         """
         return self.prop.get_size_in_points()
 
+    def get_window_extent(self, renderer):
+        """
+        get the bounding box in display space.
+        """
+        bboxes = [child.get_window_extent(renderer)
+                  for child in self.get_children()]
+
+        return Bbox.union(bboxes)
+
+    def get_tightbbox(self, renderer):
+        """
+        get tight bounding box in display space.
+        """
+        bboxes = [child.get_tightbbox(renderer)
+                  for child in self.get_children()]
+
+        return Bbox.union(bboxes)
+
     def update_positions(self, renderer):
         """
         Update the pixel positions of the annotated point and the text.
diff --git a/lib/matplotlib/tests/test_offsetbox.py b/lib/matplotlib/tests/test_offsetbox.py
@@ -1,10 +1,15 @@
 import pytest
+import io
+import numpy as np
+from numpy.testing import assert_allclose
 from matplotlib.testing.decorators import image_comparison
 import matplotlib.pyplot as plt
 import matplotlib.patches as mpatches
 import matplotlib.lines as mlines
-from matplotlib.offsetbox import (
-        AnchoredOffsetbox, DrawingArea, _get_packed_offsets)
+import matplotlib.transforms as mtransforms
+from matplotlib.offsetbox import (AnnotationBbox, OffsetImage,
+                                  AnchoredOffsetbox, DrawingArea,
+                                  _get_packed_offsets)
 
 
 @image_comparison(baseline_images=['offsetbox_clipping'], remove_text=True)
@@ -124,3 +129,79 @@ def test_get_packed_offsets(wd_list, total, sep, mode):
     # triggered inside this function when calling higher-level functions
     # (e.g. `Axes.legend`).
     _get_packed_offsets(wd_list, total, sep, mode=mode)
+
+
+def test_annotationbbox_extents():
+    plt.rcParams.update(plt.rcParamsDefault)
+    fig, ax = plt.subplots(figsize=(4, 3), dpi=100)
+
+    ax.axis([0, 1, 0, 1])
+
+    an1 = ax.annotate("Annotation", xy=(.9, .9), xytext=(1.1, 1.1),
+                      arrowprops=dict(arrowstyle="->"), clip_on=False,
+                      va="baseline", ha="left")
+
+    da = DrawingArea(20, 20, 0, 0, clip=True)
+    p = mpatches.Circle((-10, 30), 32)
+    da.add_artist(p)
+
+    ab3 = AnnotationBbox(da, [.5, .5], xybox=(-0.2, 0.5), xycoords='data',
+                        boxcoords="axes fraction", box_alignment=(0., .5),
+                        arrowprops=dict(arrowstyle="->"))
+    ax.add_artist(ab3)
+
+    im = OffsetImage(np.random.rand(10, 10), zoom=3)
+    im.image.axes = ax
+    ab6 = AnnotationBbox(im, (0.5, -.3), xybox=(0, 75),
+                         xycoords='axes fraction',
+                         boxcoords="offset points", pad=0.3,
+                         arrowprops=dict(arrowstyle="->"))
+    ax.add_artist(ab6)
+
+    fig.canvas.draw()
+    renderer = fig.canvas.get_renderer()
+
+    # Test Annotation
+    bb1w = an1.get_window_extent(renderer)
+    bb1e = an1.get_tightbbox(renderer)
+
+    target1 = [332.9, 242.8, 467.0, 298.9]
+    assert_allclose(bb1w.extents, target1, atol=2)
+    assert_allclose(bb1e.extents, target1, atol=2)
+
+    # Test AnnotationBbox
+    bb3w = ab3.get_window_extent(renderer)
+    bb3e = ab3.get_tightbbox(renderer)
+
+    target3 = [-17.6, 129.0, 200.7, 167.9]
+    assert_allclose(bb3w.extents, target3, atol=2)
+    assert_allclose(bb3e.extents, target3, atol=2)
+
+    bb6w = ab6.get_window_extent(renderer)
+    bb6e = ab6.get_tightbbox(renderer)
+
+    target6 = [180.0, -32.0, 230.0, 92.9]
+    assert_allclose(bb6w.extents, target6, atol=2)
+    assert_allclose(bb6e.extents, target6, atol=2)
+
+    # Test bbox_inches='tight'
+    buf = io.BytesIO()
+    fig.savefig(buf, bbox_inches='tight')
+    buf.seek(0)
+    shape = plt.imread(buf).shape
+    targetshape = (350, 504, 4)
+    assert_allclose(shape, targetshape, atol=2)
+
+    #test tight layout (only rough testing if extends are inside the figure
+    #                   and greater than axes extends)
+    fig.canvas.draw()
+    fig.tight_layout()
+    fig.canvas.draw()
+    bbu = mtransforms.Bbox.union((an1.get_window_extent(renderer),
+                                  ab3.get_window_extent(renderer),
+                                  ab6.get_window_extent(renderer)))
+    bbx = ax.get_window_extent(renderer)
+
+    assert np.all([bbu.x0 > 0, bbu.x0 < bbx.x0, bbu.x1 < 400, bbu.x1 > bbx.x1,
+                   bbu.y0 > 0, bbu.y0 < bbx.y0, bbu.y1 < 300, bbu.y1 > bbx.y1,
+                   bbu.width > bbx.width, bbu.height > bbx.height])
