Merge pull request #240 from pratiman-91/master

Permit setting style='default', add 'bbox' as 'border' alternative for titles/a-b-c labels

Author: lukelbd

proplot/axes/base.py

@@ -822,6 +822,11 @@ def format(
             positioned inside the axes. This can help them stand out on top
             of artists plotted inside the axes. Defaults are
             :rc:`abc.border` and :rc:`title.border`
+        abcbbox, titlebbox : bool, optional
+            Whether to draw a white bbox around titles and a-b-c labels
+            positioned inside the axes. This can help them stand out on top
+            of artists plotted inside the axes. Defaults are
+            :rc:`abc.bbox` and :rc:`title.bbox`
         titlepad : float, optional
             The padding for the inner and outer titles and a-b-c labels in
             arbitrary units (default is points). Default is :rc:`axes.titlepad`.
@@ -927,6 +932,10 @@ def sanitize_kw(kw, loc):
             if loc in ('left', 'right', 'center'):
                 kw.pop('border', None)
                 kw.pop('borderwidth', None)
+                kw.pop('bbox', None)
+                kw.pop('bboxcolor', None)
+                kw.pop('bboxstyle', None)
+                kw.pop('bboxalpha', None)
             return kw
 
         # A-b-c labels
@@ -949,6 +958,10 @@ def sanitize_kw(kw, loc):
                 {
                     'border': 'abc.border',
                     'borderwidth': 'abc.borderwidth',
+                    'bbox': 'abc.bbox',
+                    'bboxcolor': 'abc.bboxcolor',
+                    'bboxstyle': 'abc.bboxstyle',
+                    'bboxalpha': 'abc.bboxalpha',
                 },
                 context=True,
             )
@@ -1011,6 +1024,10 @@ def sanitize_kw(kw, loc):
             {
                 'border': 'title.border',
                 'borderwidth': 'title.borderwidth',
+                'bbox': 'title.bbox',
+                'bboxcolor': 'title.bboxcolor',
+                'bboxstyle': 'title.bboxstyle',
+                'bboxalpha': 'title.bboxalpha',
             },
             context=True,
         )

proplot/axes/plot.py

@@ -2179,7 +2179,7 @@ def _get_transform(self, transform):
 
 def _update_text(self, props):
     """
-    Monkey patch that adds pseudo "border" properties to text objects
+    Monkey patch that adds pseudo "border" and "bbox" properties to text objects
     without wrapping the entire class. We override update to facilitate
     updating inset titles.
     """
@@ -2201,6 +2201,20 @@ def _update_text(self, props):
             'color': facecolor,
             'path_effects': [mpatheffects.Stroke(**kwargs), mpatheffects.Normal()],
         })
+
+    bbox = props.pop('bbox', None)
+    bboxcolor = props.pop('bboxcolor', 'w')
+    bboxstyle = props.pop('bboxstyle', 'round')
+    bboxalpha = props.pop('bboxalpha', 0.5)
+
+    if bbox:
+        self.set_bbox({
+            'facecolor': bboxcolor,
+            'edgecolor': 'black',
+            'boxstyle': bboxstyle,
+            'alpha': bboxalpha,
+        })
+
     return type(self).update(self, props)
 
 
@@ -2209,11 +2223,12 @@ def text_wrapper(
     x=0, y=0, text='', transform='data',
     family=None, fontfamily=None, fontname=None, fontsize=None, size=None,
     border=False, bordercolor='w', borderwidth=2, borderinvert=False,
+    bbox=False, bboxcolor='w', bboxstyle='round', bboxalpha=0.5,
     **kwargs
 ):
     """
     Enables specifying `tranform` with a string name and adds a feature for
-    drawing borders around text.
+    drawing borders and bbox around text.
 
     Note
     ----
@@ -2248,7 +2263,14 @@ def text_wrapper(
         The color of the text border. Default is ``'w'``.
     borderinvert : bool, optional
         If ``True``, the text and border colors are swapped.
-
+    bbox : bool, optional
+        Whether to draw bbox around text.
+    bboxcolor : color-spec, optional
+        The color of the text bbox. Default is ``'w'``.
+    bboxstyle : boxstyle, optional
+        The style of the bbox. Default is ``'round'``.
+    bboxalpha : float, optional
+        The alpha for the bbox. Default is ``'0.5'``.
     Other parameters
     ----------------
     **kwargs
@@ -2287,6 +2309,10 @@ def text_wrapper(
         'bordercolor': bordercolor,
         'borderinvert': borderinvert,
         'borderwidth': borderwidth,
+        'bbox': bbox,
+        'bboxcolor': bboxcolor,
+        'bboxstyle': bboxstyle,
+        'bboxalpha': bboxalpha,
     })
     return obj
 

proplot/config.py

@@ -1158,7 +1158,11 @@ def _get_style_dicts(style, infer=False, filter=True):
     # Always apply the default style *first* so styles are rigid
     kw_matplotlib = _get_default_dict()
     if style == 'default' or style is mpl.rcParamsDefault:
-        return kw_matplotlib
+        if infer:
+            kw_proplot = _infer_added_params(kw_matplotlib)
+            return kw_matplotlib, kw_proplot
+        else:
+            return kw_matplotlib
 
     # Apply limited deviations from the matplotlib style that we want to propagate to
     # other styles. Want users selecting stylesheets to have few surprises, so

proplot/internals/rcsetup.py

@@ -266,6 +266,22 @@
         1.5,
         'Width of the white border around a-b-c labels.'
     ),
+    'abc.bbox': (
+        True,
+        'Boolean, whether to draw semi-transparent bbox around the a-b-c.'
+    ),
+    'abc.bboxcolor': (
+        'w',
+        'color-spec, the color of the a-b-c bbox.'
+    ),
+    'abc.bboxstyle': (
+        'round',
+        'boxstyle, the style of the a-b-c bbox.'
+    ),
+    'abc.bboxalpha': (
+        0.5,
+        'float, The alpha for the a-b-c bbox.'
+    ),
     'abc.color': (
         'black',
         'a-b-c label color.'
@@ -862,6 +878,23 @@
         1.5,
         'Width of the white border around titles.'
     ),
+    'title.bbox': (
+        True,
+        'Boolean, whether to draw semi-transparent bbox around the title.'
+        'when :rcraw:`title.loc` is inside the axes.'
+    ),
+    'title.bboxcolor': (
+        'w',
+        'color-spec, the color of the title bbox.'
+    ),
+    'title.bboxstyle': (
+        'round',
+        'boxstyle, the style of the title bbox.'
+    ),
+    'title.bboxalpha': (
+        0.5,
+        'float, The alpha for the title bbox.'
+    ),
     'title.color': (
         'black',
         'Axes title color.'