DOC: describe bboxprops for AnnotationBbox

rcomer · rcomer · commit 78307abde1a4 · 2022-11-13T12:09:14.000Z
diff --git a/examples/text_labels_and_annotations/demo_annotation_box.py b/examples/text_labels_and_annotations/demo_annotation_box.py
@@ -22,27 +22,28 @@
 
 # Define a 1st position to annotate (display it with a marker)
 xy = (0.5, 0.7)
-ax.plot(xy[0], xy[1], ".r")
+ax.plot(xy[0], xy[1], '.r')
 
 # Annotate the 1st position with a text box ('Test 1')
-offsetbox = TextArea("Test 1")
+offsetbox = TextArea('Test 1')
 
 ab = AnnotationBbox(offsetbox, xy,
                     xybox=(-20, 40),
                     xycoords='data',
-                    boxcoords="offset points",
-                    arrowprops=dict(arrowstyle="->"))
+                    boxcoords='offset points',
+                    arrowprops=dict(arrowstyle='->'),
+                    bboxprops=dict(boxstyle='sawtooth'))
 ax.add_artist(ab)
 
 # Annotate the 1st position with another text box ('Test')
-offsetbox = TextArea("Test")
+offsetbox = TextArea('Test')
 
 ab = AnnotationBbox(offsetbox, xy,
                     xybox=(1.02, xy[1]),
                     xycoords='data',
-                    boxcoords=("axes fraction", "data"),
+                    boxcoords=('axes fraction', 'data'),
                     box_alignment=(0., 0.5),
-                    arrowprops=dict(arrowstyle="->"))
+                    arrowprops=dict(arrowstyle='->'))
 ax.add_artist(ab)
 
 # Define a 2nd position to annotate (don't display with a marker this time)
@@ -54,11 +55,12 @@
 da.add_artist(p)
 
 ab = AnnotationBbox(da, xy,
-                    xybox=(1.02, xy[1]),
+                    xybox=(1., xy[1]),
                     xycoords='data',
-                    boxcoords=("axes fraction", "data"),
-                    box_alignment=(0., 0.5),
-                    arrowprops=dict(arrowstyle="->"))
+                    boxcoords=('axes fraction', 'data'),
+                    box_alignment=(0.2, 0.5),
+                    arrowprops=dict(arrowstyle='->'),
+                    bboxprops=dict(alpha=0.5))
 
 ax.add_artist(ab)
 
@@ -70,14 +72,14 @@
 ab = AnnotationBbox(im, xy,
                     xybox=(-50., 50.),
                     xycoords='data',
-                    boxcoords="offset points",
+                    boxcoords='offset points',
                     pad=0.3,
-                    arrowprops=dict(arrowstyle="->"))
+                    arrowprops=dict(arrowstyle='->'))
 
 ax.add_artist(ab)
 
 # Annotate the 2nd position with another image (a Grace Hopper portrait)
-with get_sample_data("grace_hopper.jpg") as file:
+with get_sample_data('grace_hopper.jpg') as file:
     arr_img = plt.imread(file)
 
 imagebox = OffsetImage(arr_img, zoom=0.2)
@@ -86,11 +88,11 @@
 ab = AnnotationBbox(imagebox, xy,
                     xybox=(120., -80.),
                     xycoords='data',
-                    boxcoords="offset points",
+                    boxcoords='offset points',
                     pad=0.5,
                     arrowprops=dict(
-                        arrowstyle="->",
-                        connectionstyle="angle,angleA=0,angleB=90,rad=3")
+                        arrowstyle='->',
+                        connectionstyle='angle,angleA=0,angleB=90,rad=3')
                     )
 
 ax.add_artist(ab)
diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py
@@ -1270,6 +1270,11 @@ def __init__(self, offsetbox, xy,
             the offset box w.r.t. the *boxcoords*.
             The lower-left corner is (0, 0) and upper-right corner is (1, 1).
 
+        bboxprops : dict, optional
+            A dictionary of properties to set for the annotation bounding box,
+            for example *boxstyle* and *alpha*.  See `.FancyBboxPatch` for
+            details.
+
         **kwargs
             Other parameters are identical to `.Annotation`.
         """
