Added fontsize= argument to legend for consistency with other matplotlib methods/functions

astrofrog · astrofrog · commit 4e9380662bcf · 2012-04-03T13:21:52.000+02:00
diff --git a/lib/matplotlib/axes.py b/lib/matplotlib/axes.py
@@ -4410,6 +4410,12 @@ def legend(self, *args, **kwargs):
             instance. If *prop* is a dictionary, a new instance will be
             created with *prop*. If *None*, use rc settings.
 
+          *fontsize*: [ size in points | 'xx-small' | 'x-small' | 'small' |
+                        'medium' | 'large' | 'x-large' | 'xx-large' ]
+            Set the font size.  May be either a size string, relative to
+            the default font size, or an absolute font size in points. This
+            argument is only used if prop is not specified.
+
           *numpoints*: integer
             The number of points in the legend for line
 
diff --git a/lib/matplotlib/legend.py b/lib/matplotlib/legend.py
@@ -134,6 +134,7 @@ def __init__(self, parent, handles, labels,
                  scatterpoints = 3,    # TODO: may be an rcParam
                  scatteryoffsets=None,
                  prop = None,          # properties for the legend texts
+                 fontsize = None,        # keyword to set font size directly
 
                  # the following dimensions are in axes coords
                  pad = None,           # deprecated; use borderpad
@@ -174,6 +175,7 @@ def __init__(self, parent, handles, labels,
         ================   ==================================================================
         loc                a location code
         prop               the font property
+        fontsize           the font size (used only if prop is not specified)
         markerscale        the relative size of legend markers vs. original
         numpoints          the number of points in the legend for line
         scatterpoints      the number of points in the legend for scatter plot
@@ -214,7 +216,10 @@ def __init__(self, parent, handles, labels,
         Artist.__init__(self)
 
         if prop is None:
-            self.prop=FontProperties(size=rcParams["legend.fontsize"])
+            if fontsize is not None:
+                self.prop=FontProperties(size=fontsize)
+            else:
+                self.prop=FontProperties(size=rcParams["legend.fontsize"])
         elif isinstance(prop, dict):
             self.prop=FontProperties(**prop)
             if "size" not in prop:
