Add experimental support for auto-layout of axes on the figure, to

mdboom · mdboom · commit 66290aae1478 · 2007-12-04T21:33:33.000Z
prevent ticks and labels from overlapping things in other axes.

svn path=/branches/transforms/; revision=4603
diff --git a/examples/auto_layout.py b/examples/auto_layout.py
@@ -0,0 +1,34 @@
+#!/usr/bin/env python
+"""
+Example: simple line plot.
+Show how to make and save a simple line plot with labels, title and grid
+"""
+from pylab import *
+
+t = arange(0.0, 1.0+0.01, 0.01)
+s = cos(2*2*pi*t)
+ax1 = subplot(211)
+plot(t, s, '-', lw=2)
+
+xlabel('xlabel for bottom axes')
+ylabel('ylabel on the right')
+title('About as simple as it gets, folks')
+grid(True)
+ax1.yaxis.set_label_position('right')
+ax1.xaxis.set_ticklabels(['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'])
+for label in ax1.get_xticklabels():
+    label.set_rotation(45)
+
+ax2 = subplot(212)
+plot(t, s, '-', lw=2)
+grid(True)
+xlabel('xlabel for bottom axes (the ticks are on the top for no good reason)')
+ylabel('I\'m a lefty')
+ax2.xaxis.set_label_position('bottom')
+ax2.xaxis.set_ticks_position('top')
+
+
+#savefig('simple_plot.png')
+savefig('simple_plot')
+
+show()
diff --git a/examples/backend_driver.py b/examples/backend_driver.py
@@ -23,6 +23,7 @@
     'alignment_test.py',
     'arctest.py',
     'arrow_demo.py',
+    'auto_layout.py',
     'axes_demo.py',
     'axhspan_demo.py',
     'bar_stacked.py',
@@ -35,7 +36,7 @@
     'cohere_demo.py',
     'contour_demo.py',
     'contourf_demo.py',
-    'csd_demo.py',    
+    'csd_demo.py',
     'custom_ticker1.py',
     'customize_rc.py',
     'date_demo1.py',
diff --git a/examples/colorbar_only.py b/examples/colorbar_only.py
@@ -7,7 +7,7 @@
 
 # Make a figure and axes with dimensions as desired.
 fig = pylab.figure(figsize=(8,1.5))
-ax = fig.add_axes([0.05, 0.4, 0.9, 0.5])
+ax = fig.add_axes([0.05, 0.05, 0.9, 0.9])
 
 # Set the colormap and norm to correspond to the data for which
 # the colorbar will be used.
diff --git a/examples/figlegend_demo.py b/examples/figlegend_demo.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 
 from pylab import *
-ax1 = axes([0.1, 0.1, 0.4, 0.7])
+ax1 = axes([0.05, 0.1, 0.4, 0.7])
 ax2 = axes([0.55, 0.1, 0.4, 0.7])
 
 x = arange(0.0, 2.0, 0.02)
diff --git a/examples/finance_demo.py b/examples/finance_demo.py
@@ -22,7 +22,7 @@
     raise SystemExit
 
 fig = figure()
-fig.subplots_adjust(bottom=0.2)
+# fig.subplots_adjust(bottom=0.2)
 ax = fig.add_subplot(111)
 ax.xaxis.set_major_locator(mondays)
 ax.xaxis.set_minor_locator(alldays)
diff --git a/examples/mathtext_demo.py b/examples/mathtext_demo.py
@@ -7,7 +7,7 @@
 from matplotlib.pyplot import figure, show
 
 fig = figure()
-fig.subplots_adjust(bottom=0.2)
+# fig.subplots_adjust(bottom=0.2)
 
 ax = fig.add_subplot(111, axisbg='y')
 ax.plot([1,2,3], 'r')
diff --git a/examples/simple_plot.py b/examples/simple_plot.py
@@ -13,6 +13,9 @@
 ylabel('voltage (mV)')
 title('About as simple as it gets, folks')
 grid(True)
+axes().xaxis.set_label_position('top')
+axes().xaxis.set_ticks_position('top')
+axes().yaxis.set_label_position('right')
 
 #savefig('simple_plot.png')
 savefig('simple_plot')
diff --git a/lib/matplotlib/axes.py b/lib/matplotlib/axes.py
@@ -770,13 +770,14 @@ def cla(self):
 
         self.grid(self._gridOn)
         props = font_manager.FontProperties(size=rcParams['axes.titlesize'])
+        self.titleOffsetTrans = mtransforms.Affine2D().translate(0.0, 10.0)
         self.title =  mtext.Text(
-            x=0.5, y=1.02, text='',
+            x=0.5, y=1.0, text='',
             fontproperties=props,
             verticalalignment='bottom',
             horizontalalignment='center',
             )
-        self.title.set_transform(self.transAxes)
+        self.title.set_transform(self.transAxes + self.titleOffsetTrans)
         self.title.set_clip_box(None)
 
         self._set_artist_props(self.title)
@@ -800,6 +801,8 @@ def cla(self):
         self.xaxis.set_clip_path(self.axesPatch)
         self.yaxis.set_clip_path(self.axesPatch)
 
+        self.titleOffsetTrans.clear()
+
     def clear(self):
         'clear the axes'
         self.cla()
@@ -905,14 +908,14 @@ def get_data_ratio(self):
         ysize = max(math.fabs(ymax-ymin), 1e-30)
         return ysize/xsize
 
-    def apply_aspect(self):
+    def apply_aspect(self, position):
         '''
         Use self._aspect and self._adjustable to modify the
         axes box or the view limits.
         '''
         aspect = self.get_aspect()
         if aspect == 'auto':
-            self.set_position( self._originalPosition , 'active')
+            self.set_position( position , 'active')
             return
 
         if aspect == 'equal':
@@ -929,7 +932,7 @@ def apply_aspect(self):
         fig_aspect = figH/figW
         if self._adjustable == 'box':
             box_aspect = A * self.get_data_ratio()
-            pb = self._originalPosition.frozen()
+            pb = position.frozen()
             pb1 = pb.shrunk_to_aspect(box_aspect, pb, fig_aspect)
             self.set_position(pb1.anchored(self.get_anchor(), pb), 'active')
             return
@@ -939,7 +942,7 @@ def apply_aspect(self):
         ymin,ymax = self.get_ybound()
         ysize = max(math.fabs(ymax-ymin), 1e-30)
 
-        l,b,w,h = self.get_position(original=True).bounds
+        l,b,w,h = position.bounds
         box_aspect = fig_aspect * (h/w)
         data_ratio = box_aspect / A
 
@@ -1014,7 +1017,7 @@ def axis(self, *v, **kwargs):
                 self.set_autoscale_on(True)
                 self.set_aspect('auto')
                 self.autoscale_view()
-                self.apply_aspect()
+                # self.apply_aspect()
                 if s=='equal':
                     self.set_aspect('equal', adjustable='datalim')
                 elif s == 'scaled':
@@ -1289,6 +1292,32 @@ def autoscale_view(self, tight=False, scalex=True, scaley=True):
             YL = ylocator.autoscale()
             self.set_ybound(YL)
 
+    def update_layout(self, renderer):
+        pad_pixels = rcParams['xtick.major.pad'] * self.figure.dpi / 72.0
+        inverse_transFigure = self.figure.transFigure.inverted()
+        t_text, b_text = self.xaxis.get_text_heights(renderer)
+        l_text, r_text = self.yaxis.get_text_widths(renderer)
+        title_height = self.title.get_window_extent(renderer).height
+        title_height += pad_pixels * 2.0
+        original_t_text = t_text
+
+        ((l_text, t_text),
+         (r_text, b_text),
+         (dummy, title_height)) = inverse_transFigure.transform(
+            ((l_text, t_text),
+             (r_text, b_text),
+             (0.0, title_height)))
+        x0, y0, x1, y1 = self.get_position(True).extents
+        # Adjust the title
+        self.titleOffsetTrans.clear().translate(
+            0, original_t_text + pad_pixels * 2.0)
+
+        new_position = mtransforms.Bbox.from_extents(
+            x0 + l_text, y0 + b_text,
+            x1 - r_text, y1 - t_text - title_height)
+
+        self.set_position(new_position, 'active')
+
     #### Drawing
     def draw(self, renderer=None, inframe=False):
         "Draw everything (plot lines, axes, labels)"
@@ -1299,7 +1328,8 @@ def draw(self, renderer=None, inframe=False):
             raise RuntimeError('No renderer defined')
         if not self.get_visible(): return
         renderer.open_group('axes')
-        self.apply_aspect()
+
+        self.apply_aspect(self.get_position())
 
         if self.axison and self._frameon:
             self.axesPatch.draw(renderer)
diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -130,11 +130,11 @@ def set_pad(self, val):
 
         ACCEPTS: float
         """
-        self._pad.set(val)
+        self._pad = val
 
     def get_pad(self, val):
         'Get the value of the tick label pad in points'
-        return self._pad.get()
+        return self._pad
 
     def _get_text1(self):
         'Get the default Text 1 instance'
@@ -578,50 +578,74 @@ def _set_artist_props(self, a):
         if a is None: return
         a.set_figure(self.figure)
 
-    def draw(self, renderer, *args, **kwargs):
-        'Draw the axis lines, grid lines, tick lines and labels'
-        if not self.get_visible(): return
-        renderer.open_group(__name__)
-        ticklabelBoxes = []
-        ticklabelBoxes2 = []
-
+    def iter_ticks(self):
+        """
+        Iterate through all of the major and minor ticks.
+        """
         majorLocs = self.major.locator()
         majorTicks = self.get_major_ticks(len(majorLocs))
         self.major.formatter.set_locs(majorLocs)
         majorLabels = [self.major.formatter(val, i) for i, val in enumerate(majorLocs)]
 
+        minorLocs = self.minor.locator()
+        minorTicks = self.get_minor_ticks(len(minorLocs))
+        self.minor.formatter.set_locs(minorLocs)
+        minorLabels = [self.minor.formatter(val, i) for i, val in enumerate(minorLocs)]
+
+        major_minor = [
+            (majorTicks, majorLocs, majorLabels),
+            (minorTicks, minorLocs, minorLabels)]
 
-        seen = {}
+        for group in major_minor:
+            for tick in zip(*group):
+                yield tick
+
+    def get_ticklabel_extents(self, renderer):
+        """
+        Get the extents of the tick labels on either side
+        of the axes.
+        """
+        ticklabelBoxes = []
+        ticklabelBoxes2 = []
 
         interval = self.get_view_interval()
-        for tick, loc, label in zip(majorTicks, majorLocs, majorLabels):
+        for tick, loc, label in self.iter_ticks():
             if tick is None: continue
             if not interval_contains(interval, loc): continue
-            seen[loc] = 1
             tick.update_position(loc)
             tick.set_label1(label)
             tick.set_label2(label)
-            tick.draw(renderer)
             if tick.label1On and tick.label1.get_visible():
                 extent = tick.label1.get_window_extent(renderer)
                 ticklabelBoxes.append(extent)
             if tick.label2On and tick.label2.get_visible():
                 extent = tick.label2.get_window_extent(renderer)
                 ticklabelBoxes2.append(extent)
 
-        minorLocs = self.minor.locator()
-        minorTicks = self.get_minor_ticks(len(minorLocs))
-        self.minor.formatter.set_locs(minorLocs)
-        minorLabels = [self.minor.formatter(val, i) for i, val in enumerate(minorLocs)]
+        if len(ticklabelBoxes):
+            bbox = Bbox.union(ticklabelBoxes)
+        else:
+            bbox = Bbox.from_extents(0, 0, 0, 0)
+        if len(ticklabelBoxes2):
+            bbox2 = Bbox.union(ticklabelBoxes2)
+        else:
+            bbox2 = Bbox.from_extents(0, 0, 0, 0)
+        return bbox, bbox2
 
-        for tick, loc, label in zip(minorTicks, minorLocs, minorLabels):
+    def draw(self, renderer, *args, **kwargs):
+        'Draw the axis lines, grid lines, tick lines and labels'
+        ticklabelBoxes = []
+        ticklabelBoxes2 = []
+
+        if not self.get_visible(): return
+        renderer.open_group(__name__)
+        interval = self.get_view_interval()
+        for tick, loc, label in self.iter_ticks():
             if tick is None: continue
             if not interval_contains(interval, loc): continue
-            #if seen.has_key(loc): continue
             tick.update_position(loc)
             tick.set_label1(label)
             tick.set_label2(label)
-
             tick.draw(renderer)
             if tick.label1On and tick.label1.get_visible():
                 extent = tick.label1.get_window_extent(renderer)
@@ -1142,6 +1166,28 @@ def _update_offset_text_position(self, bboxes, bboxes2):
             bottom = bbox.y0
         self.offsetText.set_position((x, bottom-self.OFFSETTEXTPAD*self.figure.dpi/72.0))
 
+    def get_text_heights(self, renderer):
+        """
+        Returns the amount of space one should reserve for text
+        above and below the axes.  Returns a tuple (above, below)
+        """
+        bbox, bbox2 = self.get_ticklabel_extents(renderer)
+        # MGDTODO: Need a better way to get the pad
+        padPixels = self.majorTicks[0]._padPixels
+
+        above = 0.0
+        if bbox2.height:
+            above += bbox2.height + padPixels
+        below = 0.0
+        if bbox.height:
+            below += bbox.height + padPixels
+
+        if self.get_label_position() == 'top':
+            above += self.label.get_window_extent(renderer).height + padPixels
+        else:
+            below += self.label.get_window_extent(renderer).height + padPixels
+        return above, below
+
     def set_ticks_position(self, position):
         """
         Set the ticks position (top, bottom, both, default or none)
@@ -1360,6 +1406,24 @@ def set_offset_position(self, position):
         self.offsetText.set_ha(position)
         self.offsetText.set_position((x,y))
 
+    def get_text_widths(self, renderer):
+        bbox, bbox2 = self.get_ticklabel_extents(renderer)
+        # MGDTODO: Need a better way to get the pad
+        padPixels = self.majorTicks[0]._padPixels
+
+        left = 0.0
+        if bbox.width:
+            left += bbox.width + padPixels
+        right = 0.0
+        if bbox2.width:
+            right += bbox2.width + padPixels
+
+        if self.get_label_position() == 'left':
+            left += self.label.get_window_extent(renderer).width + padPixels
+        else:
+            right += self.label.get_window_extent(renderer).width + padPixels
+        return left, right
+
     def set_ticks_position(self, position):
         """
         Set the ticks position (left, right, both or default)
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
diff --git a/lib/matplotlib/projections/polar.py b/lib/matplotlib/projections/polar.py
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
