Merge pull request matplotlib#3792 from mrkrd/master

ENH : added legend.edgecolor and legend.facecolor rcparams

Merged locally to discard a commit + it's reversion.

Author: tacaswell

doc/users/whats_new/rcparams.rst

@@ -11,3 +11,10 @@ Added "figure.titlesize" and "figure.titleweight" keys to rcParams
 
 Two new keys were added to rcParams to control the default font size and weight
 used by the figure title (as emitted by ``pyplot.suptitle()``).
+
+
+
+Added "legend.facecolor" and "legend.edgecolor" keys to rcParams
+````````````````````````````````````````````````````````````````
+
+The new keys control colors (background and edge) of legend patches.

lib/matplotlib/legend.py

@@ -346,10 +346,20 @@ def __init__(self, parent, handles, labels,
         # We use FancyBboxPatch to draw a legend frame. The location
         # and size of the box will be updated during the drawing time.
 
+        if rcParams["legend.facecolor"] is None:
+            facecolor = rcParams["axes.facecolor"]
+        else:
+            facecolor = rcParams["legend.facecolor"]
+
+        if rcParams["legend.edgecolor"] is None:
+            edgecolor = rcParams["axes.edgecolor"]
+        else:
+            edgecolor = rcParams["legend.edgecolor"]
+
         self.legendPatch = FancyBboxPatch(
             xy=(0.0, 0.0), width=1., height=1.,
-            facecolor=rcParams["axes.facecolor"],
-            edgecolor=rcParams["axes.edgecolor"],
+            facecolor=facecolor,
+            edgecolor=edgecolor,
             mutation_scale=self._fontsize,
             snap=True
             )

lib/matplotlib/mpl-data/stylelib/ggplot.mplstyle

@@ -25,6 +25,9 @@ axes.color_cycle: E24A33, 348ABD, 988ED5, 777777, FBC15E, 8EBA42, FFB5B8
                    # 8EBA42 : green
                    # FFB5B8 : pink
 
+legend.facecolor: white
+legend.edgecolor: white
+
 xtick.color: 555555
 xtick.direction: out
 
@@ -36,4 +39,3 @@ grid.linestyle: -    # solid line
 
 figure.facecolor: white
 figure.edgecolor: 0.50
-

lib/matplotlib/rcsetup.py

@@ -227,16 +227,16 @@ def __call__(self, s):
 
 def validate_color(s):
     'return a valid color arg'
-    try:
-        if s.lower() == 'none':
-            return 'None'
-    except AttributeError:
-        pass
+    if s in (None, 'none', 'None'):
+        return None
+
     if is_color_like(s):
         return s
+
     stmp = '#' + s
     if is_color_like(stmp):
         return stmp
+
     # If it is still valid, it must be a tuple.
     colorarg = s
     msg = ''
@@ -662,6 +662,9 @@ def __call__(self, s):
     # the relative size of legend markers vs. original
     'legend.markerscale': [1.0, validate_float],
     'legend.shadow': [False, validate_bool],
+    'legend.facecolor': [None, validate_color], # background color; white
+    'legend.edgecolor': [None, validate_color], # edge color; black
+
 
     ## tick properties
     'xtick.major.size':  [4, validate_float],    # major xtick size in points

lib/matplotlib/tests/test_legend.py

@@ -246,6 +246,35 @@ def test_legend_stackplot():
     ax.legend(loc=0)
 
 
+@cleanup
+def _test_rcparams_helper(test_rcparams, facecolor_target, edgecolor_target):
+    with mpl.rc_context(test_rcparams):
+        fig, ax = plt.subplots(1, 1)
+        t = np.linspace(0, 2*np.pi)
+        ax.plot(t, np.sin(t), label='sin')
+        ax.plot(t, np.cos(t), label='cos')
+        leg = ax.legend()
+
+    assert_equal(mpl.colors.colorConverter.to_rgba(facecolor_target),
+                 leg.legendPatch.get_facecolor())
+
+    assert_equal(mpl.colors.colorConverter.to_rgba(edgecolor_target),
+                 leg.legendPatch.get_edgecolor())
+
+
+def test_rcparams_():
+    test_vals = [({}, mpl.rcParams['axes.facecolor'],
+                      mpl.rcParams['axes.edgecolor']),
+                 ({'axes.facecolor': 'r', 'axes.edgecolor': 'c'}, 'r', 'c'),
+                 ({'axes.facecolor': 'r', 'axes.edgecolor': 'c',
+                   'legend.facecolor': 'w', 'legend.edgecolor': 'k'},
+                   'w', 'k'),
+                 ]
+
+    for rc_dict, face, edge in test_vals:
+        yield _test_rcparams_helper, rc_dict, face, edge
+
+
 if __name__ == '__main__':
     import nose
     nose.runmodule(argv=['-s', '--with-doctest'], exit=False)

matplotlibrc.template

@@ -256,10 +256,10 @@ backend      : %(backend)s
                                    # separator in the fr_FR locale.
 #axes.formatter.use_mathtext : False # When True, use mathtext for scientific
                                      # notation.
-#axes.formatter.useoffset      : True    # If True, the tick label formatter 
-                                         # will default to labeling ticks relative 
-                                         # to an offset when the data range is very 
-                                         # small compared to the minimum absolute 
+#axes.formatter.useoffset      : True    # If True, the tick label formatter
+                                         # will default to labeling ticks relative
+                                         # to an offset when the data range is very
+                                         # small compared to the minimum absolute
                                          # value of the data.
 
 #axes.unicode_minus  : True    # use unicode for the minus symbol
@@ -307,7 +307,7 @@ backend      : %(backend)s
 ### Legend
 #legend.fancybox      : False  # if True, use a rounded box for the
                                # legend, else a rectangle
-#legend.isaxes        : True
+#legend.isaxes        : True   # this option is internally ignored
 #legend.numpoints     : 2      # the number of points in the legend line
 #legend.fontsize      : large
 #legend.borderpad     : 0.5    # border whitespace in fontsize units
@@ -323,6 +323,10 @@ backend      : %(backend)s
 #legend.frameon       : True   # whether or not to draw a frame around legend
 #legend.framealpha    : 1.0    # opacity of of legend frame
 #legend.scatterpoints : 3 # number of scatter points
+#legend.facecolor     : None   # legend background color (when None inherits from axes.facecolor)
+#legend.edgecolor     : None   # legend edge color (when None inherits from axes.facecolor)
+
+
 
 ### FIGURE
 # See http://matplotlib.org/api/figure_api.html#matplotlib.figure.Figure
@@ -402,7 +406,7 @@ backend      : %(backend)s
 #savefig.jpeg_quality: 95       # when a jpeg is saved, the default quality parameter.
 #savefig.directory   : ~        # default directory in savefig dialog box,
                                 # leave empty to always use current working directory
-#savefig.transparent : False    # setting that controls whether figures are saved with a 
+#savefig.transparent : False    # setting that controls whether figures are saved with a
                                 # transparent background by default
 
 # tk backend params
@@ -492,5 +496,5 @@ backend      : %(backend)s
                                    # $PATH is searched
 #animation.mencoder_args: ''       # Additional arguments to pass to mencoder
 #animation.convert_path: 'convert' # Path to ImageMagick's convert binary.
-                                   # On Windows use the full path since convert 
+                                   # On Windows use the full path since convert
                                    # is also the name of a system tool.