Further cleanup rainbow_text example.

anntzer · anntzer · commit c41d4230d039 · 2023-06-03T12:31:49.000+02:00
Share more code between horizontal and vertical cases.

Show that x, y can use any transform (as for any text() call).

Standardize docs of "extra" properties.

Small doc rewordings.
diff --git a/galleries/examples/text_labels_and_annotations/rainbow_text.py b/galleries/examples/text_labels_and_annotations/rainbow_text.py
@@ -30,46 +30,44 @@ def rainbow_text(x, y, strings, colors, orientation='horizontal',
                  ax=None, **kwargs):
     """
     Take a list of *strings* and *colors* and place them next to each
-    other, with text strings[i] being shown in colors[i].
+    other, with the nth text being shown in the nth color.
 
     Parameters
     ----------
     x, y : float
-        Text position in data coordinates.
+        The position of the first string.  As for `~.Axes.text`, the coordinate
+        system can be set using the *transform* parameter.
     strings : list of str
         The strings to draw.
     colors : list of color
         The colors to use.
     orientation : {'horizontal', 'vertical'}
-    ax : Axes, optional
-        The Axes to draw into. If None, the current axes will be used.
-    **kwargs :
-        All other keyword arguments are passed to plt.text() and plt.annotate(), so you
-        can set the font size, family, etc.
+        The orientation of the text.
+    ax : Axes, default: the current Axes
+        The Axes to draw into.
+    **kwargs : `.Text` properties
     """
     if ax is None:
         ax = plt.gca()
 
-    assert orientation in ['horizontal', 'vertical']
-    if orientation == 'horizontal':
-        txt = ax.text(x, y, strings[0], color=colors[0], **kwargs)
-        for s, c in zip(strings[1:], colors[1:]):
-            txt = ax.annotate(' ' + s, xy=(1, 0), xycoords=txt,
-                              va="bottom", color=c, **kwargs)
+    assert orientation in ["horizontal", "vertical"]
+    if orientation == "horizontal":
+        xy = (1, 0)
+    elif orientation == "vertical":
+        xy = (0, 1)
+        kwargs.update(rotation=90)
 
-    elif orientation == 'vertical':
-        kwargs.update(rotation=90, verticalalignment='bottom')
-        txt = ax.text(x, y, strings[0], color=colors[0], **kwargs)
-        for s, c in zip(strings[1:], colors[1:]):
-            txt = ax.annotate(' ' + s, xy=(0, 1), xycoords=txt,
-                              va="bottom", color=c, **kwargs)
+    txt = ax.text(x, y, strings[0], color=colors[0], **kwargs)
+    for s, c in zip(strings[1:], colors[1:]):
+        txt = ax.annotate(" " + s, xy=xy, xycoords=txt,
+                          va="bottom", color=c, **kwargs)
 
 
 words = "all unicorns poop rainbows ! ! !".split()
 colors = ['red', 'orange', 'gold', 'lawngreen', 'lightseagreen', 'royalblue',
           'blueviolet']
-plt.figure(figsize=(8, 8))
-rainbow_text(0.1, 0.05, words, colors, size=18)
-rainbow_text(0.05, 0.1, words, colors, orientation='vertical', size=18)
+fig, ax = plt.subplots()
+rainbow_text(0.02, 0.02, words, colors, size=18, transform=fig.transFigure)
+rainbow_text(0.05, 0.1, words, colors, orientation='vertical')
 
 plt.show()
