Merge pull request matplotlib#1081 from pwuertz/draw_text_with_mtext

Propagate mpl.text.Text instances to the backends and fix documentation

Author: dmcdougall

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

doc/users/whats_new.rst

@@ -41,6 +41,14 @@ the whole figure. This was already the behavior for both
 :func:`~matplotlib.pyplot.axes` and :func:`~matplotlib.pyplot.subplots`, and
 now this consistency is shared with :func:`~matplotlib.pyplot.subplot`.
 
+Anchored text support
+---------------------
+The `svg` and `pgf` backends are now able to save text alignment information
+to their output formats. This allows to edit text elements in saved figures,
+using Inkscape for example, while preserving their intended position. For
+`svg` please note that you'll have to disable the default text-to-path
+conversion (`mpl.rc('svg', fonttype='none')`).
+
 .. _whats-new-1-2:
 
 new in matplotlib-1.2

lib/matplotlib/axis.py

@@ -1847,9 +1847,10 @@ def _get_label(self):
                                size=rcParams['axes.labelsize'],
                                weight=rcParams['axes.labelweight']),
             color=rcParams['axes.labelcolor'],
-            verticalalignment='center',
-            horizontalalignment='right',
+            verticalalignment='bottom',
+            horizontalalignment='center',
             rotation='vertical',
+            rotation_mode='anchor',
             )
         label.set_transform(mtransforms.blended_transform_factory(
             mtransforms.IdentityTransform(), self.axes.transAxes))

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

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()
 

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()))

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

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

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:

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