Added linewidth kwarg to bar, barh; fixed bugs

efiring · efiring · commit 529fef27d2e4 · 2006-12-09T19:44:51.000Z
svn path=/trunk/matplotlib/; revision=2913
diff --git a/API_CHANGES b/API_CHANGES
@@ -1,3 +1,5 @@
+    Added linewidth kwarg to bar and barh.
+
     Made the default Artist._transform None (rather than invoking
     identity_transform for each artist only to have it overridden
     later).  Use artist.get_transform() rather than artist._transform,
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,6 @@
+2006-12-09 Added linewidth kwarg to bar and barh; fixed arg
+           checking bugs - EF
+
 2006-12-07 Made pcolormesh argument handling match pcolor;
            fixed kwarg handling problem noted by Pierre GM - EF
 
diff --git a/examples/barh_demo.py b/examples/barh_demo.py
@@ -13,7 +13,7 @@
 grid(True)
 
 figure(2)
-barh(pos,val, xerr=rand(5), align='center')
+barh(pos,val, xerr=rand(5), ecolor='r', align='center')
 yticks(pos, ('Tom', 'Dick', 'Harry', 'Slim', 'Jim'))
 xlabel('Perfomance')
 
diff --git a/lib/matplotlib/axes.py b/lib/matplotlib/axes.py
@@ -2450,26 +2450,25 @@ def get_handles():
 
 
     def bar(self, left, height, width=0.8, bottom=0,
-            color=None, edgecolor=None, yerr=None, xerr=None, ecolor=None, capsize=3,
+            color=None, edgecolor=None, linewidth=None,
+            yerr=None, xerr=None, ecolor=None, capsize=3,
             align='edge', orientation='vertical'
             ):
         """
         BAR(left, height, width=0.8, bottom=0,
-            color=None, edgecolor=None, yerr=None, xerr=None, ecolor=None, capsize=3,
+            color=None, edgecolor=None, linewidth=None,
+            yerr=None, xerr=None, ecolor=None, capsize=3,
             align='edge', orientation='vertical')
 
         Make a bar plot with rectangles bounded by
 
-          left, left+width, bottom, bottom+height  (left, right, bottom and top edges)
+          left, left+width, bottom, bottom+height
+                (left, right, bottom and top edges)
 
         left, height, width, and bottom can be either scalars or sequences
 
         Return value is a list of Rectangle patch instances
 
-        BAR(left, height, width, bottom,
-            color, edgecolor, yerr, xerr, ecolor, capsize,
-            align, orientation)
-
             left - the x coordinates of the left sides of the bars
 
             height - the heights of the bars
@@ -2480,9 +2479,12 @@ def bar(self, left, height, width=0.8, bottom=0,
 
             bottom - the y coordinates of the bottom edges of the bars
 
-            color specifies the colors of the bars
+            color - the colors of the bars
 
-            edgecolor specifies the colors of the bar edges
+            edgecolor - the colors of the bar edges
+
+            linewidth - width of bar edges; None means use default
+                linewidth; 0 means don't draw edges.
 
             xerr and yerr, if not None, will be used to generate errorbars
             on the bar chart
@@ -2496,9 +2498,12 @@ def bar(self, left, height, width=0.8, bottom=0,
             orientation = 'vertical' | 'horizontal'
 
             For vertical bars, 'edge' aligns bars by their left edges in left,
-            while 'center' interprets these values as the x coordinates of the bar centers.
-            For horizontal bars, 'edge' aligns bars by their bottom edges in bottom,
-            while 'center' interprets these values as the y coordinates of the bar centers.
+            while 'center' interprets these values as the x coordinates
+            of the bar centers.
+            For horizontal bars, 'edge' aligns bars by their bottom edges
+            in bottom,
+            while 'center' interprets these values as the y coordinates
+            of the bar centers.
 
         The optional arguments color, edgecolor, yerr, and xerr can be either
         scalars or sequences of length equal to the number of bars
@@ -2519,6 +2524,7 @@ def make_iterable(x):
         height = make_iterable(height)
         width = make_iterable(width)
         bottom = make_iterable(bottom)
+        linewidth = make_iterable(linewidth)
 
         if orientation == 'vertical':
             # size width and bottom according to length of left
@@ -2541,6 +2547,7 @@ def make_iterable(x):
         height = asarray(height)
         width = asarray(width)
         bottom = asarray(bottom)
+        if len(linewidth) == 1: linewidth = linewidth * nbars
 
         # if color looks like a color string, an RGB tuple or a
         # scalar, then repeat it by nbars
@@ -2567,19 +2574,16 @@ def make_iterable(x):
             else:
                 xerr = asarray(xerr)
 
-        if orientation == 'vertical':
-            lenarg = 'left'
-        elif orientation == 'horizontal':
-            lenarg = 'bottom'
-        assert len(left)==nbars, 'bar() argument \'left\' must be len(%s) or scalar' % lenarg
-        assert len(height)==nbars, 'bar() argument \'height\' must be len(%s) or scalar' % lenarg
-        assert len(width)==nbars, 'bar() argument \'width\' must be len(%s) or scalar' % lenarg
-        assert len(bottom)==nbars, 'bar() argument \'bottom\' must be len(%s) or scalar' % lenarg
-        assert len(color)==nbars, 'bar() argument \'color\' must be len(%s) or scalar' % lenarg
-        assert len(edgecolor)==nbars, 'bar() argument \'edgecolor\' must be len(%s) or scalar' % lenarg
+        assert len(left)==nbars, "argument 'left' must be %d or scalar" % nbars
+        assert len(height)==nbars, "argument 'height' must be %d or scalar" % nbars
+        assert len(width)==nbars, "argument 'width' must be %d or scalar" % nbars
+        assert len(bottom)==nbars, "argument 'bottom' must be %d or scalar" % nbars
+        assert len(color)==nbars, "argument 'color' must be %d or scalar" % nbars
+        assert len(edgecolor)==nbars, "argument 'edgecolor' must be %d or scalar" % nbars
+        assert len(linewidth)==nbars, "argument 'linewidth' must be %d or scalar" % nbars
 
-        if yerr is not None: assert len(yerr)==nbars, 'bar() argument \'yerr\' must be len(%s) or scalar' % lenarg
-        if xerr is not None: assert len(xerr)==nbars, 'bar() argument \'xerr\' must be len(%s) or scalar' % lenarg
+        if yerr is not None: assert len(yerr)==nbars, "bar() argument 'yerr' must be len(%s) or scalar" % nbars
+        if xerr is not None: assert len(xerr)==nbars, "bar() argument 'xerr' must be len(%s) or scalar" % nbars
 
         patches = []
 
@@ -2593,15 +2597,16 @@ def make_iterable(x):
         else:
             raise ValueError, 'invalid alignment: %s' % align
 
-        args = zip(left, bottom, width, height, color, edgecolor)
-        for l, b, w, h, c, e in args:
+        args = zip(left, bottom, width, height, color, edgecolor, linewidth)
+        for l, b, w, h, c, e, lw in args:
             if h<0:
                 b += h
                 h = abs(h)
             r = Rectangle(
                 xy=(l, b), width=w, height=h,
                 facecolor=c,
                 edgecolor=e,
+                linewidth=lw,
                 )
             self.add_patch(r)
             patches.append(r)
@@ -2626,12 +2631,14 @@ def make_iterable(x):
 
 
     def barh(self, bottom, width, height=0.8, left=0,
-             color=None, edgecolor=None, xerr=None, yerr=None, ecolor=None, capsize=3,
+             color=None, edgecolor=None, linewidth=None,
+             xerr=None, yerr=None, ecolor=None, capsize=3,
              align='edge'
              ):
         """
         BARH(bottom, width, height=0.8, left=0,
-             color=None, edgecolor=None, xerr=None, yerr=None, ecolor=None, capsize=3,
+             color=None, edgecolor=None, linewidth=None,
+             xerr=None, yerr=None, ecolor=None, capsize=3,
              align='edge')
 
         Make a horizontal bar plot with rectangles bounded by
@@ -2642,10 +2649,6 @@ def barh(self, bottom, width, height=0.8, left=0,
 
         Return value is a list of Rectangle patch instances
 
-        BARH(bottom, width, height, left,
-             color, edgecolor, xerr, yerr, ecolor, capsize,
-             align)
-
             bottom - the vertical positions of the bottom edges of the bars
 
             width - the lengths of the bars
@@ -2671,22 +2674,24 @@ def barh(self, bottom, width, height=0.8, left=0,
             'edge' aligns the horizontal bars by their bottom edges in bottom, while
             'center' interprets these values as the y coordinates of the bar centers.
 
-        The optional arguments color, edgecolor, xerr, and yerr can be either
+        The optional arguments color, edgecolor, linewidth,
+        xerr, and yerr can be either
         scalars or sequences of length equal to the number of bars
 
         This enables you to use barh as the basis for stacked bar
         charts, or candlestick plots
         """
 
         patches = self.bar(left=left, height=height, width=width, bottom=bottom,
-                           color=color, edgecolor=edgecolor, yerr=yerr, xerr=xerr, ecolor=ecolor, capsize=capsize,
+                           color=color, edgecolor=edgecolor, linewidth=linewidth,
+                           yerr=yerr, xerr=xerr, ecolor=ecolor, capsize=capsize,
                            align=align, orientation='horizontal'
                            )
         return patches
 
     def broken_barh(self, xranges, yrange, **kwargs):
         """
-        A colleciton of horizontal bars spanning yrange with a sequence of
+        A collection of horizontal bars spanning yrange with a sequence of
         xranges
 
         xranges : sequence of (xmin, xwidth)

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+ Added linewidth kwarg to bar and barh.`
	`2`	`+`
`1`	`3`	`Made the default Artist._transform None (rather than invoking`
`2`	`4`	`identity_transform for each artist only to have it overridden`
`3`	`5`	`later). Use artist.get_transform() rather than artist._transform,`