Merge pull request #7850 from dstansby/grid1-loc-codes

tacaswell · web-flow · commit 2374c9b1f71f · 2017-01-17T20:54:00.000-05:00
FIX: Allow AnchoredOffset to take a string-like location code
diff --git a/examples/axes_grid1/inset_locator_demo.py b/examples/axes_grid1/inset_locator_demo.py
@@ -31,7 +31,7 @@ def add_sizebar(ax, size):
 # second subplot
 ax2.set_aspect(1.)
 
-axins = zoomed_inset_axes(ax2, 0.5, loc=1)  # zoom = 0.5
+axins = zoomed_inset_axes(ax2, 0.5, loc='upper right')  # zoom = 0.5
 # fix the number of ticks on the inset axes
 axins.yaxis.get_major_locator().set_params(nbins=7)
 axins.xaxis.get_major_locator().set_params(nbins=7)
diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py
@@ -33,6 +33,7 @@
 from matplotlib import rcParams
 
 from matplotlib import docstring
+from matplotlib.cbook import is_string_like
 
 #from bboximage import BboxImage
 from matplotlib.image import BboxImage
@@ -986,6 +987,19 @@ class AnchoredOffsetbox(OffsetBox):
     """
     zorder = 5  # zorder of the legend
 
+    # Location codes
+    codes = {'upper right': 1,
+             'upper left': 2,
+             'lower left': 3,
+             'lower right': 4,
+             'right': 5,
+             'center left': 6,
+             'center right': 7,
+             'lower center': 8,
+             'upper center': 9,
+             'center': 10,
+             }
+
     def __init__(self, loc,
                  pad=0.4, borderpad=0.5,
                  child=None, prop=None, frameon=True,
@@ -1028,6 +1042,14 @@ def __init__(self, loc,
         self.set_bbox_to_anchor(bbox_to_anchor, bbox_transform)
         self.set_child(child)
 
+        if is_string_like(loc):
+            try:
+                loc = self.codes[loc]
+            except KeyError:
+                raise ValueError('Unrecognized location "%s". Valid '
+                                 'locations are\n\t%s\n'
+                                 % (loc, '\n\t'.join(self.codes)))
+
         self.loc = loc
         self.borderpad = borderpad
         self.pad = pad
diff --git a/lib/matplotlib/tests/test_offsetbox.py b/lib/matplotlib/tests/test_offsetbox.py
@@ -82,5 +82,27 @@ def test_offsetbox_clip_children():
     da.clip_children = True
     assert_true(fig.stale)
 
+
+@cleanup
+def test_offsetbox_loc_codes():
+    # Check that valid string location codes all work with an AnchoredOffsetbox
+    codes = {'upper right': 1,
+             'upper left': 2,
+             'lower left': 3,
+             'lower right': 4,
+             'right': 5,
+             'center left': 6,
+             'center right': 7,
+             'lower center': 8,
+             'upper center': 9,
+             'center': 10,
+             }
+    fig, ax = plt.subplots()
+    da = DrawingArea(100, 100)
+    for code in codes:
+        anchored_box = AnchoredOffsetbox(loc=code, child=da)
+        ax.add_artist(anchored_box)
+    fig.canvas.draw()
+
 if __name__ == '__main__':
     nose.runmodule(argv=['-s', '--with-doctest'], exit=False)
