Change anchored_artists.AnchoredSizeBar: put label over rectangle

magnunor · magnunor · commit 929e8234fe98 · 2013-06-27T17:36:07.000+02:00
Add variable label_top to change the position of the label from below
the rectangle to over the rectangle
diff --git a/lib/mpl_toolkits/axes_grid1/anchored_artists.py b/lib/mpl_toolkits/axes_grid1/anchored_artists.py
@@ -67,6 +67,7 @@ class AnchoredSizeBar(AnchoredOffsetbox):
     def __init__(self, transform, size, label, loc,
                  pad=0.1, borderpad=0.1, sep=2, prop=None, 
                  frameon=True, size_vertical=0, color='black',
+                 label_top=False,
                  **kwargs):
         """
         Draw a horizontal bar with the size in data coordinate of the give axes.
@@ -91,6 +92,8 @@ def __init__(self, transform, size, label, loc,
           vertical length of the size bar, given in data coordinates
         color : str, optional
           color for the size bar and label
+        label_top : bool, optional
+          if true, the label will be over the rectangle
         
         Example:
         --------
@@ -110,7 +113,12 @@ def __init__(self, transform, size, label, loc,
 
         self.txt_label = TextArea(label, minimumdescent=False)
 
-        self._box = VPacker(children=[self.size_bar, self.txt_label],
+        if label_top:
+            _box_children = [self.txt_label, self.size_bar] 
+        else:
+            _box_children = [self.size_bar, self.txt_label] 
+
+        self._box = VPacker(children=_box_children,
                             align="center",
                             pad=0, sep=sep)
 
