Merge pull request #16615 from anntzer/boxstyles

timhoffm · web-flow · commit ed79353b6df2 · 2020-03-02T00:03:46.000+01:00
Update custom boxstyles example.
diff --git a/examples/userdemo/custom_boxstyle01.py b/examples/userdemo/custom_boxstyle01.py
@@ -1,55 +1,142 @@
-"""
+r"""
 =================
-Custom Boxstyle01
+Custom box styles
 =================
 
+This example demonstrates the implementation of a custom `.BoxStyle`.
+Custom `.ConnectionStyle`\s and `.ArrowStyle`\s can be similarly defined.
 """
+
+from matplotlib.patches import BoxStyle
 from matplotlib.path import Path
+import matplotlib.pyplot as plt
+
+
+###############################################################################
+# Custom box styles can be implemented as a function that takes arguments
+# specifying both a rectangular box and the amount of "mutation", and
+# returns the "mutated" path.  The specific signature is the one of
+# ``custom_box_style`` below.
+#
+# Here, we return a new path which adds an "arrow" shape on the left of the
+# box.
+#
+# The custom box style can then be used by passing
+# ``bbox=dict(boxstyle=custom_box_style, ...)`` to `.Axes.text`.
 
 
 def custom_box_style(x0, y0, width, height, mutation_size, mutation_aspect=1):
     """
-    Given the location and size of the box, return the path of
-    the box around it.
-
-     - *x0*, *y0*, *width*, *height* : location and size of the box
-     - *mutation_size* : a reference scale for the mutation.
-     - *aspect_ratio* : aspect-ration for the mutation.
+    Given the location and size of the box, return the path of the box around
+    it.
+
+    Rotation is automatically taken care of.
+
+    Parameters
+    ----------
+    x0, y0, width, height : float
+        Box location and size.
+    mutation_size : float
+        Mutation reference scale, typically the text font size.
+    mutation_aspect
+        Mutation aspect ratio.
     """
-
-    # note that we are ignoring mutation_aspect. This is okay in general.
+    # We ignore mutation_aspect. This is okay in general.
 
     # padding
     mypad = 0.3
     pad = mutation_size * mypad
-
     # width and height with padding added.
     width = width + 2 * pad
     height = height + 2 * pad
-
     # boundary of the padded box
     x0, y0 = x0 - pad, y0 - pad
     x1, y1 = x0 + width, y0 + height
+    # return the new path
+    return Path([(x0, y0),
+                 (x1, y0), (x1, y1), (x0, y1),
+                 (x0-pad, (y0+y1)/2), (x0, y0),
+                 (x0, y0)],
+                closed=True)
 
-    cp = [(x0, y0),
-          (x1, y0), (x1, y1), (x0, y1),
-          (x0-pad, (y0+y1)/2.), (x0, y0),
-          (x0, y0)]
-
-    com = [Path.MOVETO,
-           Path.LINETO, Path.LINETO, Path.LINETO,
-           Path.LINETO, Path.LINETO,
-           Path.CLOSEPOLY]
 
-    path = Path(cp, com)
-
-    return path
+fig, ax = plt.subplots(figsize=(3, 3))
+ax.text(0.5, 0.5, "Test", size=30, va="center", ha="center", rotation=30,
+        bbox=dict(boxstyle=custom_box_style, alpha=0.2))
 
 
-import matplotlib.pyplot as plt
+###############################################################################
+# Alternatively, custom box styles can be implemented as subclasses of
+# ``matplotlib.patches.BoxStyle._Base``, by overriding the ``transmute``
+# method, as demonstrated below.
+#
+# The subclass can then be registered into the ``BoxStyle._style_list`` dict,
+# which allows specifying the box style as a string,
+# ``bbox=dict(boxstyle="registered_name,param=value,...", ...)``.
+#
+# Note that this approach relies on internal APIs and is therefore not
+# officially supported.
+
+
+class MyStyle(BoxStyle._Base):
+    """A simple box."""
+
+    def __init__(self, pad=0.3):
+        """
+        The arguments must be floats and have default values.
+
+        Parameters
+        ----------
+        pad : float
+            amount of padding
+        """
+        self.pad = pad
+        super().__init__()
+
+    def transmute(self, x0, y0, width, height, mutation_size):
+        """
+        Given the location and size of the box, return the path of the box
+        around it.
+
+        Rotation is automatically taken care of.
+
+        Parameters
+        ----------
+        x0, y0, width, height : float
+            Box location and size.
+        mutation_size : float
+            Reference scale for the mutation, typically the text font size.
+
+        Notes
+        -----
+        Unlike when defining the box style as a function (as in
+        `custom_box_style`), here there is no *mutation_aspect* parameter.
+        Matplotlib will first squeeze the box's y-axis by *mutation_aspect*
+        before calling the `transmute` method, and then later reexpand the
+        y-axis by the same amount.
+        """
+        # padding
+        pad = mutation_size * self.pad
+        # width and height with padding added
+        width = width + 2.*pad
+        height = height + 2.*pad
+        # boundary of the padded box
+        x0, y0 = x0 - pad, y0 - pad
+        x1, y1 = x0 + width, y0 + height
+        # return the new path
+        return Path([(x0, y0),
+                     (x1, y0), (x1, y1), (x0, y1),
+                     (x0-pad, (y0+y1)/2.), (x0, y0),
+                     (x0, y0)],
+                    closed=True)
+
+
+BoxStyle._style_list["angled"] = MyStyle  # Register the custom style.
 
 fig, ax = plt.subplots(figsize=(3, 3))
-ax.text(0.5, 0.5, "Test", size=30, va="center", ha="center",
-        bbox=dict(boxstyle=custom_box_style, alpha=0.2))
+ax.text(0.5, 0.5, "Test", size=30, va="center", ha="center", rotation=30,
+        bbox=dict(boxstyle="angled,pad=0.5", alpha=0.2))
+
+del BoxStyle._style_list["angled"]  # Unregister it.
 
 plt.show()
diff --git a/examples/userdemo/custom_boxstyle02.py b/examples/userdemo/custom_boxstyle02.py
diff --git a/tutorials/text/annotations.py b/tutorials/text/annotations.py
@@ -590,17 +590,6 @@ def __call__(self, x0, y0, width, height, mutation_size,
 
    Custom Boxstyle01
 
-However, it is recommended that you derive from the
-matplotlib.patches.BoxStyle._Base as demonstrated below.
-
-.. figure:: ../../gallery/userdemo/images/sphx_glr_custom_boxstyle02_001.png
-   :target: ../../gallery/userdemo/custom_boxstyle02.html
-   :align: center
-   :scale: 50
-
-   Custom Boxstyle02
-
-
 Similarly, you can define a custom ConnectionStyle and a custom ArrowStyle.
 See the source code of ``lib/matplotlib/patches.py`` and check
 how each style class is defined.
