added bbox prop to text

jdh2358 · jdh2358 · commit e50ff69d189a · 2004-11-29T20:32:48.000Z
svn path=/trunk/matplotlib/; revision=722
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,4 +1,9 @@
 New entries should be added at the top
+2004-11-30 Added bbox property to text - JDH
+
+2004-11-29 Added the over command to the matlab interface.  over
+           allows you to add an overlay plot regardless of hold
+	   state. - JDH
 
 2004-11-25 Added Printf to mplutils for printf style format string
            formatting in C++ (should help write better exceptions)
diff --git a/TODO b/TODO
@@ -593,4 +593,10 @@ ZeroDivisionError: SeparableTransformation::eval_scalars yin interval is zero; c
 
 -- Humufr's shared ticker bug
 
--- figure should increment the figure if one already exists
+-- figure should increment the figure if one already exists
+
+-- majbase and minbase to plot
+
+-- oplot
+
+-- override setattr in matlab interface for artists.
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -129,3 +129,11 @@ def set_visible(self, b):
 ACCEPTS: [True | False]
 """
         self._visible = b
+
+    def update(self, props):
+        for k,v in props.items():
+            func = getattr(self, 'set_'+k, None)
+            if func is None or not callable(func):
+                raise AttributeError('Unknown property %s'%k)
+            func(v)
+            print 'set', k, v
diff --git a/lib/matplotlib/axes.py b/lib/matplotlib/axes.py
@@ -2297,7 +2297,7 @@ def set_title(self, label, fontdict=None, **kwargs):
 
         self.title.set_text(label)
         override = _process_text_args({}, fontdict, **kwargs)
-        self.title.update_properties(override)
+        self.title.update(override)
         return self.title
 
 
@@ -2312,7 +2312,7 @@ def set_xlabel(self, xlabel, fontdict=None, **kwargs):
         label = self.xaxis.get_label()
         label.set_text(xlabel)
         override = _process_text_args({}, fontdict, **kwargs)
-        label.update_properties(override)
+        label.update(override)
         return label
 
     def _send_xlim_event(self):
@@ -2396,7 +2396,7 @@ def set_ylabel(self, ylabel, fontdict=None, **kwargs):
         label = self.yaxis.get_label()
         label.set_text(ylabel)
         override = _process_text_args({}, fontdict, **kwargs)
-        label.update_properties(override)
+        label.update(override)
         return label
 
     def set_ylim(self, v, emit=True):
@@ -2679,7 +2679,7 @@ def text(self, x, y, s, fontdict=None, **kwargs):
             )
         self._set_artist_props(t)
 
-        t.update_properties(override)
+        t.update(override)
         self.texts.append(t)
 
         if t.get_clip_on():  t.set_clip_box(self.bbox)
@@ -3040,7 +3040,7 @@ def set_rgrids(self, radii, labels=None, angle=22.5, **kwargs):
                      fontproperties=props, color=color,
                      horizontalalignment='center', verticalalignment='center')
             t.set_transform(self.transData)
-            t.update_properties(kwargs)
+            t.update(kwargs)
             self._set_artist_props(t)
             t.set_clip_on(False)
             self.rgridlabels.append(t)
@@ -3098,7 +3098,7 @@ def set_thetagrids(self, angles, labels=None, fmt='%d', frac = 1.1,
             t = Text(a/180.*math.pi, r, l, fontproperties=props, color=color,
                      horizontalalignment='center', verticalalignment='center')
             t.set_transform(self.transData)
-            t.update_properties(kwargs)
+            t.update(kwargs)
             self._set_artist_props(t)
             t.set_clip_on(False)
             self.thetagridlabels.append(t)
diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -678,7 +678,7 @@ def set_ticklabels(self, ticklabels, *args, **kwargs):
         ret = []
         for i, tick in enumerate(self.get_major_ticks()):
             if i<len(ticklabels): ret.append(tick.label1)
-            tick.label1.update_properties(override)
+            tick.label1.update(override)
         return ret
     
     def set_ticks(self, ticks):
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -312,7 +312,7 @@ def text(self, x, y, s, *args, **kwargs):
             x=x, y=y, text=s,
             )
 
-        t.update_properties(override)
+        t.update(override)
         self._set_artist_props(t)
         self.texts.append(t)
         return t
diff --git a/lib/matplotlib/matlab.py b/lib/matplotlib/matlab.py
@@ -1401,7 +1401,7 @@ def xticks(*args, **kwargs):
     else: raise RuntimeError('Illegal number of arguments to xticks')
     if len(kwargs):
         for l in labels:
-            l.update_properties(kwargs)
+            l.update(kwargs)
             
     draw_if_interactive()
     return locs, labels
@@ -1536,7 +1536,7 @@ def yticks(*args, **kwargs):
     else: raise RuntimeError('Illegal number of arguments to yticks')
     if len(kwargs):
         for l in labels:
-            l.update_properties(kwargs)
+            l.update(kwargs)
     
     draw_if_interactive()
 
@@ -1555,3 +1555,14 @@ def polar(*args, **kwargs):
 
     ax = gca(polar=True)
     return ax.plot(*args, **kwargs)
+
+
+def over(func, *args, **kwargs):
+    """
+Call func(*args, **kwargs) with hold(True) and then restore the hold state
+    """
+    h = ishold()
+    hold(True)
+    func(*args, **kwargs)
+    hold(h)
+
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -3,7 +3,7 @@
 from matplotlib import rcParams
 from numerix import array, arange, sin, cos, pi, Float
 from artist import Artist
-from cbook import True, False, enumerate
+from cbook import True, False, enumerate, popd
 from colors import colorConverter
 from transforms import bound_vertices
 
@@ -122,7 +122,7 @@ def draw(self, renderer):
         tverts = self._transform.seq_xy_tups(verts)
 
         renderer.draw_polygon(gc, rgbFace, tverts)
-        if 0: bbox_artist(self, renderer)
+
         #renderer.close_group('patch')
         
     def get_verts(self):
@@ -323,23 +323,32 @@ def __init__(self, xy, radius=5,
                                 orientation=0,
                                 **kwargs)
         
-def bbox_artist(artist, renderer):
+def bbox_artist(artist, renderer, props=None):
     """
     This is a debug function to draw a rectangle around the bounding
     box returned by get_window_extent of an artist, to test whether
     the artist is returning the correct bbox
-    """
 
+    props is a dict of rectangle props with the additional property
+    'pad' that sets the padding around the bbox in points
+    """
+    if props is None: props = {}
+    pad = popd(props, 'pad', 4)
+    pad = renderer.points_to_pixels(pad)
     bbox = artist.get_window_extent(renderer)
     l,b,w,h = bbox.get_bounds()
+    l-=pad/2.
+    b-=pad/2.
+    w+=pad
+    h+=pad
     r = Rectangle(xy=(l,b), 
                   width=w, 
                   height=h, 
-                  fill=False,
                   )
     r.set_clip_on( False )
+    r.update(props)
     r.draw(renderer)
-
+    
 
 def draw_bbox(bbox, renderer, color='k', trans=None):
     """
diff --git a/lib/matplotlib/table.py b/lib/matplotlib/table.py
@@ -140,7 +140,7 @@ def get_required_width(self, renderer):
 
     def set_text_props(self, **kwargs):
         'update the text properties with kwargs'
-        self._text.update_properties(kwargs)
+        self._text.update(kwargs)
 
 class Table(Artist):
     """
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -6,7 +6,7 @@
 import matplotlib
 import math
 from artist import Artist
-from cbook import True, False, enumerate
+from cbook import True, False, enumerate, popd
 from font_manager import FontProperties
 from matplotlib import rcParams
 from patches import bbox_artist
@@ -55,7 +55,8 @@ def __init__(self,
         self._multialignment = multialignment        
         self._rotation = rotation
         self._fontproperties = fontproperties
-
+        self._bbox = None
+        
     def _get_multialignment(self):
         if self._multialignment is not None: return self._multialignment
         else: return self._horizontalalignment
@@ -194,6 +195,14 @@ def _get_layout(self, renderer):
         return ret
          
 
+    def set_bbox(self, rectprops):
+        """
+Draw a bounding box around self.  rect props are any settable
+properties for a rectangle, eg color='r', alpha=0.5
+
+ACCEPTS: rectangle prop dict plus key 'pad' which is a pad in points
+        """
+        self._bbox = rectprops
 
     def draw(self, renderer):
         if self._text=='': return
@@ -205,7 +214,9 @@ def draw(self, renderer):
             gc.set_clip_rectangle(self.clipbox.get_bounds())
 
 
-        if 0: bbox_artist(self, renderer)
+            
+        if self._bbox:
+            bbox_artist(self, renderer, self._bbox)
         angle = self.get_rotation()
         bbox, info = self._get_layout(renderer)
 
@@ -507,14 +518,6 @@ def set_text(self, s):
         self._text = s
 
 
-    def update_properties(self, d):
-        "Update the font attributes with the dictionary in d"
-        for k,v in d.items():
-            val = d[k]
-            funcname = 'set_' + k
-            assert(hasattr(self, funcname))
-            func = getattr(self, funcname)
-            func(val)
 
 
     def is_math_text(self):

Original file line number	Diff line number	Diff line change
`@@ -312,7 +312,7 @@ def text(self, x, y, s, args, *kwargs):`
`312`	`312`	`x=x, y=y, text=s,`
`313`	`313`	`)`
`314`	`314`
`315`		`- t.update_properties(override)`
	`315`	`+ t.update(override)`
`316`	`316`	`self._set_artist_props(t)`
`317`	`317`	`self.texts.append(t)`
`318`	`318`	`return t`