ENH: add a FormattedText artist

Author: tacaswell

data_prototype/wrappers.py

@@ -8,6 +8,7 @@
 from matplotlib.lines import Line2D as _Line2D
 from matplotlib.image import AxesImage as _AxesImage
 from matplotlib.patches import StepPatch as _StepPatch
+from matplotlib.text import Text as _Text
 from matplotlib.collections import LineCollection as _LineCollection
 from matplotlib.artist import Artist as _Artist
 
@@ -229,6 +230,26 @@ def _update_wrapped(self, data):
         self._wrapped_instance.set_data(data["density"], data["edges"])
 
 
+class FormatedText(ProxyWrapper):
+    _wrapped_class = _Text
+    _privtized_methods = ("set_text",)
+
+    def __init__(self, data: DataContainer, format_func, nus=None, /, **kwargs):
+        super().__init__(data, nus)
+        self._wrapped_instance = self._wrapped_class(text="", **kwargs)
+        self._format_func = format_func
+
+    @_stale_wrapper
+    def draw(self, renderer):
+        self._update_wrapped(
+            self._query_and_transform(renderer, xunits=[], yunits=[]),
+        )
+        return self._wrapped_instance.draw(renderer)
+
+    def _update_wrapped(self, data):
+        self._wrapped_instance.set_text(self._format_func(**data))
+
+
 @_forwarder(
     (
         "set_clip_path",

examples/animation.py

@@ -15,7 +15,8 @@
 from matplotlib.animation import FuncAnimation
 
 from data_prototype.containers import _Transform, Desc
-from data_prototype.wrappers import LineWrapper
+
+from data_prototype.wrappers import LineWrapper, FormatedText
 
 
 class SinOfTime:
@@ -46,7 +47,7 @@ def next_time():
                 "x": th,
                 "y": np.sin(th + phase),
                 "phase": phase,
-                "time": time,
+                "time": cur_time,
             }, hash(cur_time)
 
         return next_time()
@@ -58,9 +59,16 @@ def update(frame, art):
 
 sot_c = SinOfTime()
 lw = LineWrapper(sot_c, lw=5, color="green", label="sin(time)")
-
+fc = FormatedText(
+    sot_c,
+    "ϕ={phase:.2f}  ".format,
+    x=2 * np.pi,
+    y=1,
+    ha="right",
+)
 fig, ax = plt.subplots()
 ax.add_artist(lw)
+ax.add_artist(fc)
 ax.set_xlim(0, 2 * np.pi)
 ax.set_ylim(-1.1, 1.1)
 ani = FuncAnimation(