unified hlines and vlines

jdh2358 · jdh2358 · commit 333c801f90ee · 2005-09-01T16:16:59.000Z
svn path=/trunk/matplotlib/; revision=1701
diff --git a/API_CHANGES b/API_CHANGES
@@ -1,5 +1,9 @@
 API Changes in matplotlib-0.84
 
+    Unified argument handling between hlines and vlines.  Both now 
+    take optionally a fmt argument (as in plot) and a keyword args
+    that can be passed onto Line2D.
+
     Removed all references to "data clipping" in rc and lines.py since
     these were not used and not optimized.  I'm sure they'll be
     resurrected later with a better implementation when needed.
diff --git a/examples/vline_demo.py b/examples/vline_demo.py
@@ -14,7 +14,7 @@ def f(t):
 nse = multiply(normal(0.0, 0.3, t.shape), s)
 
 plot(t, s+nse, 'b^')
-vlines(t, [0], s, color='k')
+vlines(t, [0], s, fmt='k-')
 xlabel('time (s)')
 title('Comparison of model with data')
 show()
diff --git a/lib/matplotlib/axes.py b/lib/matplotlib/axes.py
@@ -1900,7 +1900,7 @@ def in_axes(self, xwin, ywin):
         'return True is the point xwin, ywin (display coords) are in the Axes'
         return self.bbox.contains(xwin, ywin)
 
-    def hlines(self, y, xmin, xmax, fmt='k-'):
+    def hlines(self, y, xmin, xmax, fmt='k-', **kwargs):
         """
         HLINES(y, xmin, xmax, fmt='k-')
 
@@ -1909,11 +1909,18 @@ def hlines(self, y, xmin, xmax, fmt='k-'):
         respective values are constant, else the widths of the lines are
         determined by xmin and xmax
 
+        fmt is a plot format string, eg 'g--'
+        
+        kwargs are matplotlib.lines.Line2D kwargs
+
         Returns a list of line instances that were added
         """
         linestyle, marker, color = _process_plot_format(fmt)
 
-        # todo: fix me for y is scalar and xmin and xmax are iterable
+
+        if not iterable(y): y = [y]
+        if not iterable(xmin): xmin = [xmin]
+        if not iterable(xmax): xmax = [xmax]        
         y = asarray(y)
         xmin = asarray(xmin)
         xmax = asarray(xmax)
@@ -1933,6 +1940,7 @@ def hlines(self, y, xmin, xmax, fmt='k-'):
             line = Line2D(
                 [thisMin, thisMax], [thisY, thisY],
                 color=color, linestyle=linestyle, marker=marker,
+                **kwargs
                 )
             self.add_line( line )
             lines.append(line)
@@ -3562,7 +3570,7 @@ def toggle_log_lineary(self):
         if funcy==LOG10: self.set_yscale('linear')
         elif funcy==IDENTITY: self.set_yscale('log')
 
-    def vlines(self, x, ymin, ymax, color='k'):
+    def vlines(self, x, ymin, ymax, fmt='k-', **kwargs):
         """
         VLINES(x, ymin, ymax, color='k')
 
@@ -3571,8 +3579,19 @@ def vlines(self, x, ymin, ymax, color='k'):
         respective values are constant, else the heights of the lines are
         determined by ymin and ymax
 
+
+        fmt is a plot format string, eg 'g--'
+
+        kwargs are matplotlib.lines.Line2D kwargs
+        
         Returns a list of lines that were added
         """
+        linestyle, marker, color = _process_plot_format(fmt)
+        
+
+        if not iterable(x): x = [x]
+        if not iterable(ymin): ymin = [ymin]
+        if not iterable(ymax): ymax = [ymax]        
         x = asarray(x)
         ymin = asarray(ymin)
         ymax = asarray(ymax)
@@ -3592,7 +3611,9 @@ def vlines(self, x, ymin, ymax, color='k'):
         lines = []
         for thisX, thisY in zip(x,Y):
             line = Line2D(
-                [thisX, thisX], thisY, color=color, linestyle='-',
+                [thisX, thisX], thisY,
+                color=color, linestyle=linestyle, marker=marker,
+                **kwargs
                 )
             self.add_line(line)
             lines.append(line)
