Bbox off by default, flush when on, turns off border (improves #240)

Author: lukelbd

WHATSNEW.rst

@@ -61,7 +61,7 @@ ProPlot v0.8.0 (2021-##-##)
 
 .. rubric:: Internals
 
-* Assignments to `~proplot.rctools.rc_configurator` are now validated, and
+* Assignments to `~proplot.config.RcConfigurator` are now validated, and
   the configurator is now a monkey patch of `~matplotlib.rcParams`
   (:pr:`109`).
 * Plotting wrapper features (e.g. `~proplot.wrappers.standardize_1d`) are now
@@ -103,6 +103,7 @@ ProPlot v0.7.0 (2021-06-30)
   by `Mickaël Lalande`_.
 * Add `titlebbox` and `abcbbox` as alternatives to `titleborder` and `abcborder`
   for "inner" titles and a-b-c labels (:pr:`240`) by `Pratiman Patel`_.
+  Default behavior uses borders.
 * Add `nozero` keyword arg to `cmap_changer` to remove the zero contour
   from automatically generated levels (:commit:`10e0f13b`).
   Example usage: ``ax.contour(x, y, z, nozero=True)``.
@@ -358,6 +359,8 @@ ProPlot v0.6.0 (2020-05-20)
   degree-shifted colormap, similar to ``'cmap_r'`` (:commit:`da4ccb08`).
 * Rename ``GrayCycle`` colormap to ``MonoCycle`` to more accurately reflect
   colormap design origins (:commit:`d67e45bf`).
+* Rename `~proplot.config.rc_configurator` to `~proplot.config.RcConfigurator`
+  to match capitalized class naming convention.
 * Rename `~proplot.colors.MidpointNorm` to more intuitive
   `~proplot.colors.DivergingNorm`, and make "fair" color scaling the default
   behavior (:commit:`2f549c9`).
@@ -395,8 +398,8 @@ ProPlot v0.6.0 (2020-05-20)
   used for minor gridlines is `~matplotlib.ticker.AutoMinorLocator`.
 * Add `loninline`, `latinline`, and `rotatelabels` keywords for controlling
   cartopy gridliner behavior (:pr:`168`).
-* Add `proplot.config.rc_configurator.save` and
-  `proplot.config.rc_configurator.from_file` methods (:pr:`167`, :commit:`e6dd8314`).
+* Add `proplot.config.RcConfigurator.save` and
+  `proplot.config.RcConfigurator.from_file` methods (:pr:`167`, :commit:`e6dd8314`).
 * Increase default :rcraw:`savefig.dpi` to 1200, matching recommendations
   from academic journals (:pr:`167`, :commit:`c00e7314`). Also add detailed discussion
   to user guide.
@@ -483,7 +486,7 @@ ProPlot v0.6.0 (2020-05-20)
 * Fix deprecation of direct access to ``matplotlib.cm.cmap_d``
   in matplotlib >=3.2.0 (:pr:`149`, :commit:`a69c16da`).
 * Fix issues with string font sizes (:pr:`149`, :commit:`6121de03`). Add hidden
-  `~proplot.config.rc_configurator._get_font_size` method to
+  `~proplot.config.RcConfigurator._get_font_size` method to
   translate font size to numeric.
 * Fix issue where passing actual projection instances generated with
   `~proplot.constructor.Proj` to `~proplot.ui.subplots` could incorrectly

proplot/axes/plot.py

@@ -2184,6 +2184,8 @@ def _update_text(self, props):
     updating inset titles.
     """
     props = props.copy()  # shallow copy
+
+    # Update border
     border = props.pop('border', None)
     bordercolor = props.pop('bordercolor', 'w')
     borderinvert = props.pop('borderinvert', False)
@@ -2202,17 +2204,21 @@ def _update_text(self, props):
             'path_effects': [mpatheffects.Stroke(**kwargs), mpatheffects.Normal()],
         })
 
+    # Update bounding box
+    # NOTE: For some reason using pad / 10 results in perfect alignment. Matplotlib
+    # docs are vague about bounding box units, maybe they are tens of points?
     bbox = props.pop('bbox', None)
     bboxcolor = props.pop('bboxcolor', 'w')
     bboxstyle = props.pop('bboxstyle', 'round')
     bboxalpha = props.pop('bboxalpha', 0.5)
-
+    bboxpad = _not_none(props.pop('bboxpad', None), self.axes._title_pad / 10)
     if bbox:
         self.set_bbox({
-            'facecolor': bboxcolor,
             'edgecolor': 'black',
+            'facecolor': bboxcolor,
             'boxstyle': bboxstyle,
             'alpha': bboxalpha,
+            'pad': bboxpad,
         })
 
     return type(self).update(self, props)
@@ -2223,7 +2229,7 @@ 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,
+    bbox=False, bboxcolor='w', bboxstyle='round', bboxalpha=0.5, bboxpad=None,
     **kwargs
 ):
     """
@@ -2264,13 +2270,16 @@ def text_wrapper(
     borderinvert : bool, optional
         If ``True``, the text and border colors are swapped.
     bbox : bool, optional
-        Whether to draw bbox around text.
+        Whether to draw a bouning box around text.
     bboxcolor : color-spec, optional
-        The color of the text bbox. Default is ``'w'``.
+        The color of the text bouning box. Default is ``'w'``.
     bboxstyle : boxstyle, optional
-        The style of the bbox. Default is ``'round'``.
+        The style of the bouning box. Default is ``'round'``.
     bboxalpha : float, optional
-        The alpha for the bbox. Default is ``'0.5'``.
+        The alpha for the bounding box. Default is ``'0.5'``.
+    bboxpad : float, optional
+        The padding of the bounding box. Default is :rc:`title.pad` / 10.
+
     Other parameters
     ----------------
     **kwargs
@@ -2313,6 +2322,7 @@ def text_wrapper(
         'bboxcolor': bboxcolor,
         'bboxstyle': bboxstyle,
         'bboxalpha': bboxalpha,
+        'bboxpad': bboxpad,
     })
     return obj
 

proplot/config.py

@@ -419,6 +419,13 @@ def _get_synced_params(self, key, value):
             kw_proplot.update(ikw_proplot)
             kw_matplotlib.update(ikw_matplotlib)
 
+        # Turning bounding box on should turn border off and vice versa
+        elif key in ('abc.bbox', 'title.bbox', 'abc.border', 'title.border'):
+            if value:
+                name, this = key.split('.')
+                other = 'border' if this == 'bbox' else 'border'
+                kw_proplot[name + '.' + other] = False
+
         # Tick length/major-minor tick length ratio
         elif key in ('tick.len', 'tick.lenratio'):
             if key == 'tick.len':

proplot/internals/rcsetup.py

@@ -267,20 +267,24 @@
         'Width of the white border around a-b-c labels.'
     ),
     'abc.bbox': (
-        True,
+        False,
         '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.'
+        'Color-spec, the color of the a-b-c bbox.'
     ),
     'abc.bboxstyle': (
-        'round',
-        'boxstyle, the style of the a-b-c bbox.'
+        'square',
+        'Box style, the style of the a-b-c bbox.'
     ),
     'abc.bboxalpha': (
         0.5,
-        'float, The alpha for the a-b-c bbox.'
+        'Float, the alpha for the a-b-c bbox.'
+    ),
+    'abc.bboxpad': (
+        None,
+        'Float, the alpha for the a-b-c bbox.'
     ),
     'abc.color': (
         'black',
@@ -879,21 +883,25 @@
         'Width of the white border around titles.'
     ),
     'title.bbox': (
-        True,
+        False,
         '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.'
+        'Color-spec, the color of the a-b-c bbox.'
     ),
     'title.bboxstyle': (
-        'round',
-        'boxstyle, the style of the title bbox.'
+        'square',
+        'Box style, the style of the a-b-c bbox.'
     ),
     'title.bboxalpha': (
         0.5,
-        'float, The alpha for the title bbox.'
+        'Float, the alpha for the a-b-c bbox.'
+    ),
+    'title.bboxpad': (
+        None,
+        'Float, the alpha for the a-b-c bbox.'
     ),
     'title.color': (
         'black',