Improvements to anchored_artists.AnchoredSizeBar

magnunor · pelson · commit cf9cd634695c · 2014-01-09T13:58:17.000Z
Fix: color argument was not setting the color of the textlabel
Add: setting the font-size through the fontsize argument
diff --git a/lib/mpl_toolkits/axes_grid1/anchored_artists.py b/lib/mpl_toolkits/axes_grid1/anchored_artists.py
@@ -71,7 +71,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,
+                 label_top=False, fontsize=12,
                  **kwargs):
         """
         Draw a horizontal bar with the size in data coordinate of the give axes.
@@ -97,7 +97,9 @@ def __init__(self, transform, size, label, loc,
         color : str, optional
           color for the size bar and label
         label_top : bool, optional
-          if true, the label will be over the rectangle
+          if True, the label will be over the rectangle
+        fontsize : int, optional
+          sets the fontsize for the label
 
         Example:
         --------
@@ -106,16 +108,19 @@ def __init__(self, transform, size, label, loc,
         >>>> 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')
+        >>>> 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', fontsize=20)
         >>>> ax.add_artist(bar)
-        >>>> plt.show()
+        >>>> fig.show()
 
         """
 
         self.size_bar = AuxTransformBox(transform)
         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.txt_label = TextArea(
+            label, 
+            minimumdescent=False, 
+            textprops=dict(color=color, fontsize=fontsize))
 
         if label_top:
             _box_children = [self.txt_label, self.size_bar]
