Merge pull request #7019 from dmkent/fix-suptitle-fontproperties

NelleV · tacaswell · commit cf8e6696de4f · 2016-09-24T14:23:15.000-04:00
Check for fontproperties in figure.suptitle.
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -522,6 +522,11 @@ def suptitle(self, t, **kwargs):
           *verticalalignment* : 'top'
             The vertical alignment of the text
 
+        If the `fontproperties` keyword argument is given then the
+        rcParams defaults for `fontsize` (`figure.titlesize`) and
+        `fontweight` (`figure.titleweight`) will be ignored in favour
+        of the `FontProperties` defaults.
+
         A :class:`matplotlib.text.Text` instance is returned.
 
         Example::
@@ -536,10 +541,11 @@ def suptitle(self, t, **kwargs):
         if ('verticalalignment' not in kwargs) and ('va' not in kwargs):
             kwargs['verticalalignment'] = 'top'
 
-        if 'fontsize' not in kwargs and 'size' not in kwargs:
-            kwargs['size'] = rcParams['figure.titlesize']
-        if 'fontweight' not in kwargs and 'weight' not in kwargs:
-            kwargs['weight'] = rcParams['figure.titleweight']
+        if 'fontproperties' not in kwargs:
+            if 'fontsize' not in kwargs and 'size' not in kwargs:
+                kwargs['size'] = rcParams['figure.titlesize']
+            if 'fontweight' not in kwargs and 'weight' not in kwargs:
+                kwargs['weight'] = rcParams['figure.titleweight']
 
         sup = self.text(x, y, t, **kwargs)
         if self._suptitle is not None:
diff --git a/lib/matplotlib/tests/test_figure.py b/lib/matplotlib/tests/test_figure.py
@@ -99,6 +99,17 @@ def test_suptitle():
     fig.suptitle('title', color='g', rotation='30')
 
 
+@cleanup
+def test_suptitle_fontproperties():
+    from matplotlib.font_manager import FontProperties
+    fig = plt.figure()
+    ax = fig.add_subplot(1, 1, 1)
+    fps = FontProperties(size='large', weight='bold')
+    txt = fig.suptitle('fontprops title', fontproperties=fps)
+    assert_equal(txt.get_fontsize(), fps.get_size_in_points())
+    assert_equal(txt.get_weight(), fps.get_weight())
+
+
 @image_comparison(baseline_images=['alpha_background'],
                   # only test png and svg. The PDF output appears correct,
                   # but Ghostscript does not preserve the background color.
