propagate mpl.text.Text instances to backends, fix documentation

matplotlib · dmcdougall · Nov 30, 2012 · Aug 13, 2012 · Oct 7, 2012 · Aug 14, 2012
commit 347c408adc48f7d88a9c16dd91fabf433dd70e7c
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,8 @@
+2012-11-27 Added the *mtext* parameter for supplying matplotlib.text.Text
+           instances to RendererBase.draw_tex and RendererBase.draw_text.
+           This allows backends to utilize additional text attributes, like
+           the alignment of text elements. - pwuertz
+
 2012-11-16 plt.set_cmap no longer throws errors if there is not already
           an active colorable artist, such as an image, and just sets
           up the colormap to use from that point forward. - PI

diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -443,12 +443,12 @@ def option_scale_image(self):
        """
        return False

-    def draw_tex(self, gc, x, y, s, prop, angle, ismath='TeX!'):
+    def draw_tex(self, gc, x, y, s, prop, angle, ismath='TeX!', mtext=None):
        """
        """
        self._draw_text_as_path(gc, x, y, s, prop, angle, ismath="TeX")

-    def draw_text(self, gc, x, y, s, prop, angle, ismath=False):
+    def draw_text(self, gc, x, y, s, prop, angle, ismath=False, mtext=None):
        """
        Draw the text instance

@@ -462,14 +462,17 @@ def draw_text(self, gc, x, y, s, prop, angle, ismath=False):
            the y location of the text in display coords

        *s*
-             a :class:`matplotlib.text.Text` instance
+            the text string

        *prop*
          a :class:`matplotlib.font_manager.FontProperties` instance

        *angle*
            the rotation angle in degrees

+        *mtext*
+            a :class:`matplotlib.text.Text` instance
+
        **backend implementers note**

        When you are trying to determine if you have gotten your bounding box

diff --git a/lib/matplotlib/backends/backend_agg.py b/lib/matplotlib/backends/backend_agg.py
@@ -158,7 +158,7 @@ def draw_mathtext(self, gc, x, y, s, prop, angle):
        y = int(y) - oy
        self._renderer.draw_text_image(font_image, x, y + 1, angle, gc)

-    def draw_text(self, gc, x, y, s, prop, angle, ismath):
+    def draw_text(self, gc, x, y, s, prop, angle, ismath=False, mtext=None):
        """
        Render the text
        """
@@ -215,7 +215,7 @@ def get_text_width_height_descent(self, s, prop, ismath):
        return w, h, d


-    def draw_tex(self, gc, x, y, s, prop, angle):
+    def draw_tex(self, gc, x, y, s, prop, angle, ismath='TeX!', mtext=None):
        # todo, handle props, angle, origins
        size = prop.get_size_in_points()


diff --git a/lib/matplotlib/backends/backend_cairo.py b/lib/matplotlib/backends/backend_cairo.py
@@ -177,7 +177,7 @@ def draw_image(self, gc, x, y, im):

        im.flipud_out()

-    def draw_text(self, gc, x, y, s, prop, angle, ismath=False):
+    def draw_text(self, gc, x, y, s, prop, angle, ismath=False, mtext=None):
        # Note: x,y are device/display coords, not user-coords, unlike other
        # draw_* methods
        if _debug: print('%s.%s()' % (self.__class__.__name__, _fn_name()))

diff --git a/lib/matplotlib/backends/backend_emf.py b/lib/matplotlib/backends/backend_emf.py
@@ -358,7 +358,7 @@ def draw_rectangle(self, gcEdge, rgbFace, x, y, width, height):
            if debugPrint: print("draw_rectangle: optimizing away (%f,%f) w=%f,h=%f" % (x,y,width,height))


-    def draw_text(self, gc, x, y, s, prop, angle, ismath=False):
+    def draw_text(self, gc, x, y, s, prop, angle, ismath=False, mtext=None):
        """
        Draw the text.Text instance s at x,y (display coords) with font
        properties instance prop at angle in degrees, using GraphicsContext gc

diff --git a/lib/matplotlib/backends/backend_gdk.py b/lib/matplotlib/backends/backend_gdk.py
@@ -138,7 +138,7 @@ def draw_image(self, gc, x, y, im):
        im.flipud_out()


-    def draw_text(self, gc, x, y, s, prop, angle, ismath):
+    def draw_text(self, gc, x, y, s, prop, angle, ismath=False, mtext=None):
        x, y = int(x), int(y)

        if x < 0 or y < 0: # window has shrunk and text is off the edge

diff --git a/lib/matplotlib/backends/backend_macosx.py b/lib/matplotlib/backends/backend_macosx.py
@@ -111,7 +111,7 @@ def draw_image(self, gc, x, y, im):
                      *gc.get_clip_path())
        im.flipud_out()

-    def draw_tex(self, gc, x, y, s, prop, angle):
+    def draw_tex(self, gc, x, y, s, prop, angle, ismath='TeX!', mtext=None):
        # todo, handle props, angle, origins
        size = prop.get_size_in_points()
        texmanager = self.get_texmanager()
@@ -128,7 +128,7 @@ def _draw_mathtext(self, gc, x, y, s, prop, angle):
            self.mathtext_parser.parse(s, self.dpi, prop)
        gc.draw_mathtext(x, y, angle, 255 - image.as_array())

-    def draw_text(self, gc, x, y, s, prop, angle, ismath=False):
+    def draw_text(self, gc, x, y, s, prop, angle, ismath=False, mtext=None):
        if ismath:
            self._draw_mathtext(gc, x, y, s, prop, angle)
        else:

diff --git a/lib/matplotlib/backends/backend_pdf.py b/lib/matplotlib/backends/backend_pdf.py
@@ -1671,7 +1671,7 @@ def draw_mathtext(self, gc, x, y, s, prop, angle):
        # Pop off the global transformation
        self.file.output(Op.grestore)

-    def draw_tex(self, gc, x, y, s, prop, angle):
+    def draw_tex(self, gc, x, y, s, prop, angle, ismath='TeX!', mtext=None):
        texmanager = self.get_texmanager()
        fontsize = prop.get_size_in_points()
        dvifile = texmanager.make_dvi(s, fontsize)
@@ -1763,7 +1763,7 @@ def encode_string(self, s, fonttype):
            return s.encode('cp1252', 'replace')
        return s.encode('utf-16be', 'replace')

-    def draw_text(self, gc, x, y, s, prop, angle, ismath=False):
+    def draw_text(self, gc, x, y, s, prop, angle, ismath=False, mtext=None):
        # TODO: combine consecutive texts into one BT/ET delimited section

        # This function is rather complex, since there is no way to

diff --git a/lib/matplotlib/backends/backend_pgf.py b/lib/matplotlib/backends/backend_pgf.py
@@ -595,10 +595,10 @@ def draw_image(self, gc, x, y, im):
        writeln(self.fh, r"\pgftext[at=\pgfqpoint{%fin}{%fin},left,bottom]{\pgfimage[interpolate=true,width=%fin,height=%fin]{%s}}" % (x * f, y * f, w * f, h * f, fname_img))
        writeln(self.fh, r"\end{pgfscope}")

-    def draw_tex(self, gc, x, y, s, prop, angle, ismath="TeX!"):
-        self.draw_text(gc, x, y, s, prop, angle, ismath)
+    def draw_tex(self, gc, x, y, s, prop, angle, ismath="TeX!", mtext=None):
+        self.draw_text(gc, x, y, s, prop, angle, ismath, mtext)

-    def draw_text(self, gc, x, y, s, prop, angle, ismath=False):
+    def draw_text(self, gc, x, y, s, prop, angle, ismath=False, mtext=None):
        s = common_texification(s)

        # apply font properties

diff --git a/lib/matplotlib/backends/backend_ps.py b/lib/matplotlib/backends/backend_ps.py
@@ -649,7 +649,7 @@ def draw_path_collection(self, gc, master_transform, paths, all_transforms,

        self._path_collection_id += 1

-    def draw_tex(self, gc, x, y, s, prop, angle, ismath='TeX!'):
+    def draw_tex(self, gc, x, y, s, prop, angle, ismath='TeX!', mtext=None):
        """
        draw a Text instance
        """
@@ -684,7 +684,7 @@ def draw_tex(self, gc, x, y, s, prop, angle, ismath='TeX!'):
        self._pswriter.write(ps)
        self.textcnt += 1

-    def draw_text(self, gc, x, y, s, prop, angle, ismath):
+    def draw_text(self, gc, x, y, s, prop, angle, ismath=False, mtext=None):
        """
        draw a Text instance
        """

diff --git a/lib/matplotlib/backends/backend_svg.py b/lib/matplotlib/backends/backend_svg.py
@@ -1053,10 +1053,10 @@ def _draw_text_as_text(self, gc, x, y, s, prop, angle, ismath):

            writer.end(u'g')

-    def draw_tex(self, gc, x, y, s, prop, angle):
+    def draw_tex(self, gc, x, y, s, prop, angle, ismath='TeX!', mtext=None):
        self._draw_text_as_path(gc, x, y, s, prop, angle, ismath="TeX")

-    def draw_text(self, gc, x, y, s, prop, angle, ismath):
+    def draw_text(self, gc, x, y, s, prop, angle, ismath=False, mtext=None):
        clipid = self._get_clip(gc)
        if clipid is not None:
            # Cannot apply clip-path directly to the text, because

diff --git a/lib/matplotlib/backends/backend_template.py b/lib/matplotlib/backends/backend_template.py
@@ -104,7 +104,7 @@ def draw_path(self, gc, path, transform, rgbFace=None):
    def draw_image(self, gc, x, y, im):
        pass

-    def draw_text(self, gc, x, y, s, prop, angle, ismath=False):
+    def draw_text(self, gc, x, y, s, prop, angle, ismath=False, mtext=None):
        pass

    def flipy(self):

diff --git a/lib/matplotlib/backends/backend_wx.py b/lib/matplotlib/backends/backend_wx.py
@@ -361,11 +361,7 @@ def draw_image(self, gc, x, y, im):
        gc.gfx_ctx.DrawBitmap(bitmap,int(l),int(self.height-b),int(w),int(-h))
        gc.unselect()

-    def draw_text(self, gc, x, y, s, prop, angle, ismath):
-        """
-        Render the matplotlib.text.Text instance
-        None)
-        """
+    def draw_text(self, gc, x, y, s, prop, angle, ismath=False, mtext=None):
        if ismath: s = self.strip_math(s)
        DEBUG_MSG("draw_text()", 1, self)
        gc.select()

diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -585,10 +585,11 @@ def draw(self, renderer):
                if self.get_path_effects():
                    for path_effect in self.get_path_effects():
                        path_effect.draw_tex(renderer, gc, x, y, clean_line,
-                                             self._fontproperties, angle)
+                                             self._fontproperties, angle,
+                                             mtext=self)
                else:
                    renderer.draw_tex(gc, x, y, clean_line,
-                                      self._fontproperties, angle)
+                                      self._fontproperties, angle, mtext=self)
        else:
            for line, wh, x, y in info:
                if not np.isfinite(x) or not np.isfinite(y):
@@ -604,11 +605,11 @@ def draw(self, renderer):
                    for path_effect in self.get_path_effects():
                        path_effect.draw_text(renderer, gc, x, y, clean_line,
                                              self._fontproperties, angle,
-                                              ismath=ismath)
+                                              ismath=ismath, mtext=self)
                else:
                    renderer.draw_text(gc, x, y, clean_line,
                                       self._fontproperties, angle,
-                                       ismath=ismath)
+                                       ismath=ismath, mtext=self)

        gc.restore()
        renderer.close_group('text')