support for shared axes

jdh2358 · jdh2358 · commit d4d0cc2b8458 · 2005-01-27T21:46:32.000Z
svn path=/trunk/matplotlib/; revision=889
diff --git a/API_CHANGES b/API_CHANGES
@@ -1,3 +1,8 @@
+API CHANGES in matplotlib-0.72
+
+  Line2D, Text, and Patch copy_properties renamed update_from and
+  moved into artist base class
+
 API CHANGES in matplotlib-0.71   
 
    Significant numerix namespace changes, introduced to resolve
diff --git a/examples/shared_axis_demo.py b/examples/shared_axis_demo.py
@@ -8,6 +8,26 @@
 changes in the axis scaling (eg log vs linear).  However, it is
 possible to have differences in tick labeling, eg you can selectively
 turn off the tick labels on one axes.
+
+The example below shows how to customize the tick labels on the
+various axes.  Shared axes share the tick locator, tick formatter,
+view limits, and transformation (eg log, linear).  But the ticklabels
+themselves do not share properties.  This is a feature and not a bug,
+because you may want to make the tick labels smaller on the upper
+axes, eg in the example below.
+
+If you want to turn off the ticklabels for a given axes (eg on
+subplot(211) or subplot(212), you cannot do the standard trick
+
+   set(ax2, =[])
+
+because this changes the tick Formatter, which is shared among all
+axes.  But you can alter the visibility of the labels, which is a
+property
+
+  set( ax2.get_xticklabels(), visible=False)
+
+
 """
 from pylab import *
 
@@ -17,10 +37,14 @@
 s3 = sin(4*pi*t)
 ax1 = subplot(311)
 plot(t,s1)
+plot(t, s2)
+set( ax1.get_xticklabels(), fontsize=6)
 
 ## share x only
 ax2 = subplot(312, sharex=ax1)
-plot(t, s2)
+
+# make these tick labels invisible
+set( ax2.get_xticklabels(), visible=False)
 
 # share x and y
 ax3 = subplot(313,  sharex=ax1, sharey=ax1)
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -163,3 +163,14 @@ def set_zorder(self, level):
 """
         self.zorder = level
     
+    def update_from(self, other):
+        'copy properties from other to self'
+        self._transform = other._transform
+        self._transformSet = other._transformSet
+        self._visible = other._visible
+        self._alpha = other._alpha
+        self.clipbox = other.clipbox
+        self._clipon = other._clipon
+        self._lod = other._lod
+        self._label = other._label
+        
diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -584,12 +584,12 @@ def _get_tick(self, major):
     def _copy_tick_props(self, src, dest):
         'Copy the props from src tick to dest tick'
         if src is None or dest is None: return 
-        dest.label1.copy_properties(src.label1)
-        dest.label2.copy_properties(src.label2)
+        dest.label1.update_from(src.label1)
+        dest.label2.update_from(src.label2)
 
-        dest.tick1line.copy_properties(src.tick1line)
-        dest.tick2line.copy_properties(src.tick2line)        
-        dest.gridline.copy_properties(src.gridline)
+        dest.tick1line.update_from(src.tick1line)
+        dest.tick2line.update_from(src.tick2line)        
+        dest.gridline.update_from(src.gridline)
 
         dest.tick1On = src.tick1On
         dest.tick2On = src.tick2On
diff --git a/lib/matplotlib/legend.py b/lib/matplotlib/legend.py
@@ -217,7 +217,7 @@ def _get_handles(self, handles, texts):
                 ydata = (y-HEIGHT/2)*ones(self._xdata.shape, Float)
                 legline = Line2D(self._xdata, ydata)
                 self._set_artist_props(legline)
-                legline.copy_properties(handle)
+                legline.update_from(handle)
                 legline.set_markersize(self.markerscale*legline.get_markersize())
                 legline.set_data_clipping(False)
                 ret.append(legline)
@@ -226,7 +226,7 @@ def _get_handles(self, handles, texts):
                 p = Rectangle(xy=(min(self._xdata), y-3/4*HEIGHT),
                               width = self.handlelen, height=HEIGHT/2,
                               )
-                p.copy_properties(handle)
+                p.update_from(handle)
                 self._set_artist_props(p)
                 ret.append(p)
             elif isinstance(handle, LineCollection):
diff --git a/lib/matplotlib/lines.py b/lib/matplotlib/lines.py
@@ -722,22 +722,23 @@ def _draw_x(self, renderer, gc, xt, yt):
             renderer.draw_line(gc, x-offset, y-offset, x+offset, y+offset)
             renderer.draw_line(gc, x-offset, y+offset, x+offset, y-offset)
 
-    def copy_properties(self, line):
-        'copy properties from line to self'
-        self._linestyle = line._linestyle
-        self._linewidth = line._linewidth
-        self._color = line._color
-        self._markersize = line._markersize        
-        self._markerfacecolor = line._markerfacecolor
-        self._markeredgecolor = line._markeredgecolor
-        self._markeredgewidth = line._markeredgewidth
-        self._dashSeq = line._dashSeq
-
-        self._linestyle = line._linestyle
-        self._marker = line._marker
-        self._lineFunc = line._lineStyles[line._linestyle]
-        self._markerFunc = line._markers[line._marker]
-        self._useDataClipping = line._useDataClipping
+    def update_from(self, other):
+        'copy properties from other to self'
+        Artist.update_from(self, other)        
+        self._linestyle = other._linestyle
+        self._linewidth = other._linewidth
+        self._color = other._color
+        self._markersize = other._markersize        
+        self._markerfacecolor = other._markerfacecolor
+        self._markeredgecolor = other._markeredgecolor
+        self._markeredgewidth = other._markeredgewidth
+        self._dashSeq = other._dashSeq
+
+        self._linestyle = other._linestyle
+        self._marker = other._marker
+        self._lineFunc = other._lineStyles[other._linestyle]
+        self._markerFunc = other._markers[other._marker]
+        self._useDataClipping = other._useDataClipping
 
     def _get_rgb_face(self):
         if (self._markerfacecolor is None or
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -44,7 +44,8 @@ def __init__(self,
                 func = getattr(self, func)
                 func(v)
         
-    def copy_properties(self, other):
+    def update_from(self, other):
+        Artist.update_from(self, other)        
         self.set_edgecolor(other.get_edgecolor())
         self.set_facecolor(other.get_facecolor())
         self.set_fill(other.get_fill())
@@ -194,7 +195,7 @@ def __init__(self, patch, ox, oy, props=None):
         self._update()
 
     def _update(self):        
-        self.copy_properties(self.patch)
+        self.update_from(self.patch)
         if self.props is not None:
             self.update(self.props)
         else:
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -75,15 +75,15 @@ def get_rotation(self):
             angle = float(self._rotation)
         return angle%360
     
-    def copy_properties(self, t):
+    def update_from(self, other):
         'Copy properties from t to self'
-
-        self._color = t._color
-        self._multialignment = t._multialignment        
-        self._verticalalignment = t._verticalalignment
-        self._horizontalalignment = t._horizontalalignment
-        self._fontproperties = t._fontproperties.copy()
-        self._rotation = t._rotation
+        Artist.update_from(self, other)
+        self._color = other._color
+        self._multialignment = other._multialignment        
+        self._verticalalignment = other._verticalalignment
+        self._horizontalalignment = other._horizontalalignment
+        self._fontproperties = other._fontproperties.copy()
+        self._rotation = other._rotation
 
 
     def _get_layout(self, renderer):
