Add 'borderstyle' text() keyword

proplot-dev · Oct 5, 2021 · 25e21c7 · 25e21c7
1 parent 53f77b0
commit 25e21c7
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 7 deletions.
diff --git a/proplot/axes/base.py b/proplot/axes/base.py
@@ -2891,10 +2891,9 @@ def legend(
     @docstring._concatenate_inherited
     @docstring._snippet_manager
     def text(
-        self, *args,
-        border=False, bordercolor='w', borderwidth=2, borderinvert=False,
-        bbox=False, bboxcolor='w', bboxstyle='round', bboxalpha=0.5, bboxpad=None,
-        **kwargs
+        self, *args, border=False, bbox=False,
+        bordercolor='w', borderwidth=2, borderinvert=False, borderstyle='miter',
+        bboxcolor='w', bboxstyle='round', bboxalpha=0.5, bboxpad=None, **kwargs
     ):
         """
         Add text to the axes.
@@ -2919,6 +2918,10 @@ def text(
             The color of the text border. Default is ``'w'``.
         borderinvert : bool, optional
             If ``True``, the text and border colors are swapped.
+        borderstyle : {'miter', 'round', 'bevel'}, optional
+            The `line join style \
+<https://matplotlib.org/stable/gallery/lines_bars_and_markers/joinstyle.html>`__
+            used for the border.
         bbox : bool, optional
             Whether to draw a bounding box around text.
         bboxcolor : color-spec, optional
@@ -2970,6 +2973,7 @@ def text(
                 'bordercolor': bordercolor,
                 'borderinvert': borderinvert,
                 'borderwidth': borderwidth,
+                'borderstyle': borderstyle,
                 'bbox': bbox,
                 'bboxcolor': bboxcolor,
                 'bboxstyle': bboxstyle,

diff --git a/proplot/internals/text.py b/proplot/internals/text.py
@@ -34,18 +34,19 @@ def _update_text(text, props=None, **kwargs):
     bordercolor = props.pop('bordercolor', 'w')
     borderinvert = props.pop('borderinvert', False)
     borderwidth = props.pop('borderwidth', 2)
+    borderstyle = props.pop('borderstyle', 'miter')
     if border:
         facecolor, bgcolor = text.get_color(), bordercolor
         if borderinvert:
             facecolor, bgcolor = bgcolor, facecolor
-        kwargs = {
+        kw = {
             'linewidth': borderwidth,
             'foreground': bgcolor,
-            'joinstyle': 'miter',
+            'joinstyle': borderstyle,
         }
         text.set_color(facecolor)
         text.set_path_effects(
-            [mpatheffects.Stroke(**kwargs), mpatheffects.Normal()],
+            [mpatheffects.Stroke(**kw), mpatheffects.Normal()],
         )
     elif border is False:
         text.set_path_effects(None)