Added linespacing kwarg to text

efiring · efiring · commit 815cbd8188ce · 2007-07-11T07:57:31.000Z
svn path=/trunk/matplotlib/; revision=3497
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -300,7 +300,7 @@ def __call__(self, s):
 
 
     # font props
-    'font.family'       : ['serif', str],            # used by text object
+    'font.family'       : ['sans-serif', str],       # used by text object
     'font.style'        : ['normal', str],           #
     'font.variant'      : ['normal', str],           #
     'font.stretch'      : ['normal', str],           #
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -106,6 +106,7 @@ def get_rotation(rotation):
             fontproperties: a matplotlib.font_manager.FontProperties instance
             horizontalalignment or ha: [ 'center' | 'right' | 'left' ]
             label: any string
+            linespacing: float
             lod: [True | False]
             multialignment: ['left' | 'right' | 'center' ]
             name or fontname: string eg, ['Sans' | 'Courier' | 'Helvetica' ...]
@@ -144,6 +145,7 @@ def __init__(self,
                  multialignment=None,
                  fontproperties=None, # defaults to FontProperties()
                  rotation=None,
+                 linespacing=1.2,
                  **kwargs
                  ):
         """
@@ -167,13 +169,14 @@ def __init__(self,
         self._fontproperties = fontproperties
         self._bbox = None
         self._renderer = None
+        self._linespacing = linespacing
         self.update(kwargs)
         #self.set_bbox(dict(pad=0))
     __init__.__doc__ = cbook.dedent(__init__.__doc__) % artist.kwdocd
 
     def contains(self,mouseevent):
-        """Test whether the mouse event occurred in the patch.  
-        
+        """Test whether the mouse event occurred in the patch.
+
         Returns T/F, {}
         """
         if callable(self._contains): return self._contains(self,mouseevent)
@@ -189,7 +192,7 @@ def contains(self,mouseevent):
         xyverts = (l,b), (l, t), (r, t), (r, b)
         x, y = mouseevent.x, mouseevent.y
         inside = nxutils.pnpoly(x, y, xyverts)
-        return inside,{}        
+        return inside,{}
 
     def _get_xy_display(self):
         'get the (possibly unit converted) transformed x,y in display coords'
@@ -227,6 +230,7 @@ def update_from(self, other):
         self._fontproperties = other._fontproperties.copy()
         self._rotation = other._rotation
         self._picker = other._picker
+        self._linespacing = other._linespacing
 
     def _get_layout(self, renderer):
 
@@ -236,7 +240,6 @@ def _get_layout(self, renderer):
         key = self.get_prop_tup()
         if self.cached.has_key(key): return self.cached[key]
         horizLayout = []
-        pad =2
         thisx, thisy = self._get_xy_display()
         width = 0
         height = 0
@@ -248,16 +251,16 @@ def _get_layout(self, renderer):
             lines = self._text.split('\n')
 
         whs = []
+        # Find full vertical extent, including ascenders and descenders:
         tmp, heightt = renderer.get_text_width_height(
-                'T', self._fontproperties, ismath=False)
+                'Tglp', self._fontproperties, ismath=False)
 
-        heightt += 3  # 3 pixel pad
         for line in lines:
             w,h = renderer.get_text_width_height(
                 line, self._fontproperties, ismath=self.is_math_text())
 
             whs.append( (w,h) )
-            offsety = heightt+pad
+            offsety = heightt * self._linespacing
             horizLayout.append((line, thisx, thisy, w, h))
             thisy -= offsety  # now translate down by text height, window coords
             width = max(width, w)
@@ -621,6 +624,14 @@ def set_multialignment(self, align):
             raise ValueError('Horizontal alignment must be one of %s' % str(legal))
         self._multialignment = align
 
+    def set_linespacing(self, spacing):
+        """
+        Set the line spacing as a multiple of the font size.
+
+        ACCEPTS: float
+        """
+        self._linespacing = spacing
+
     def set_family(self, fontname):
         """
         Set the font family
@@ -1196,14 +1207,14 @@ def __init__(self, s, xy,
         self.xycoords = xycoords
         self.textcoords = textcoords
     __init__.__doc__ = cbook.dedent(__init__.__doc__) % artist.kwdocd
-    
+
     def contains(self,event):
         t,tinfo = Text.contains(self,event)
         if self.arrow is not None:
             a,ainfo=self.arrow.contains(event)
             t = t or a
         return t,tinfo
-            
+
 
     def set_clip_box(self, clipbox):
         """
