Merge pull request #2158 from magnunor/anchored_size_bar_height

leejjoon · leejjoon · commit 59e4adadd2df · 2013-08-06T23:30:56.000-07:00
Changes to anchored_artists.AnchoredSizeBar
diff --git a/lib/mpl_toolkits/axes_grid1/anchored_artists.py b/lib/mpl_toolkits/axes_grid1/anchored_artists.py
@@ -65,21 +65,60 @@ def __init__(self, transform, width, height, angle, loc,
 
 class AnchoredSizeBar(AnchoredOffsetbox):
     def __init__(self, transform, size, label, loc,
-                 pad=0.1, borderpad=0.1, sep=2, prop=None, frameon=True,
+                 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.
         A label will be drawn underneath (center-aligned).
 
-        pad, borderpad in fraction of the legend font size (or prop)
-        sep in points.
+        Parameters:
+        -----------
+        transform : matplotlib transformation object
+        size : int or float
+          horizontal length of the size bar, given in data coordinates
+        label : str
+        loc : int
+        pad : int or float, optional
+          in fraction of the legend font size (or prop)
+        borderpad : int or float, optional
+          in fraction of the legend font size (or prop)
+        sep : int or float, optional
+          in points
+        frameon : bool, optional
+          if True, will draw a box around the horizontal bar and label
+        size_vertical : int or float, optional
+          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:
+        --------
+        >>>> import matplotlib.pyplot as plt
+        >>>> import numpy as np
+        >>>> from mpl_toolkits.axes_grid1.anchored_artists import AnchoredSizeBar
+        >>>> fig, ax = plt.subplots()
+        >>>> ax = imshow(np.random.random((10,10)))
+        >>>> bar = AnchoredSizeBar(ax.transData, 3, '3 units', pad=0.5, loc=4, sep=5, borderpad=0.5, frameon=False, size_vertical=0.5, color='white')
+        >>>> ax.add_artist(bar)
+        >>>> plt.show()
+
         """
+
         self.size_bar = AuxTransformBox(transform)
-        self.size_bar.add_artist(Rectangle((0,0), size, 0, fc="none"))
+        self.size_bar.add_artist(Rectangle((0,0), size, size_vertical, fill=True, facecolor=color, edgecolor=color))
 
         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)
 
