Revision: 8369
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=8369&view=rev
Author: efiring
Date: 2010-06-02 20:41:10 +0000 (Wed, 02 Jun 2010)
Log Message:
-----------
Axes.bar: added error_kw kwarg
Modified Paths:
--------------
trunk/matplotlib/CHANGELOG
trunk/matplotlib/doc/api/api_changes.rst
trunk/matplotlib/examples/pylab_examples/barchart_demo.py
trunk/matplotlib/lib/matplotlib/axes.py
Modified: trunk/matplotlib/CHANGELOG
===================================================================
--- trunk/matplotlib/CHANGELOG 2010-06-02 19:25:13 UTC (rev 8368)
+++ trunk/matplotlib/CHANGELOG 2010-06-02 20:41:10 UTC (rev 8369)
@@ -1,3 +1,5 @@
+2010-06-02 Add error_kw kwarg to Axes.bar(). - EF
+
2010-06-01 Fix pcolormesh() and QuadMesh to pass on kwargs as
appropriate. - RM
Modified: trunk/matplotlib/doc/api/api_changes.rst
===================================================================
--- trunk/matplotlib/doc/api/api_changes.rst 2010-06-02 19:25:13 UTC (rev
8368)
+++ trunk/matplotlib/doc/api/api_changes.rst 2010-06-02 20:41:10 UTC (rev
8369)
@@ -10,6 +10,10 @@
Changes beyond 0.99.x
=====================
+* The :meth:`matplotlib.axes.Axes.bar` method accepts a *error_kw*
+ kwarg; it is a dictionary of kwargs to be passed to the
+ errorbar function.
+
* The :meth:`matplotlib.axes.Axes.hist` *color* kwarg now accepts
a sequence of color specs to match a sequence of datasets.
Modified: trunk/matplotlib/examples/pylab_examples/barchart_demo.py
===================================================================
--- trunk/matplotlib/examples/pylab_examples/barchart_demo.py 2010-06-02
19:25:13 UTC (rev 8368)
+++ trunk/matplotlib/examples/pylab_examples/barchart_demo.py 2010-06-02
20:41:10 UTC (rev 8369)
@@ -12,11 +12,17 @@
plt.subplot(111)
-rects1 = plt.bar(ind, menMeans, width, color='r', yerr=menStd)
+rects1 = plt.bar(ind, menMeans, width,
+ color='r',
+ yerr=menStd,
+ error_kw=dict(elinewidth=6, ecolor='pink'))
womenMeans = (25, 32, 34, 20, 25)
womenStd = (3, 5, 2, 3, 3)
-rects2 = plt.bar(ind+width, womenMeans, width, color='y', yerr=womenStd)
+rects2 = plt.bar(ind+width, womenMeans, width,
+ color='y',
+ yerr=womenStd,
+ error_kw=dict(elinewidth=6, ecolor='yellow'))
# add some
plt.ylabel('Scores')
Modified: trunk/matplotlib/lib/matplotlib/axes.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/axes.py 2010-06-02 19:25:13 UTC (rev
8368)
+++ trunk/matplotlib/lib/matplotlib/axes.py 2010-06-02 20:41:10 UTC (rev
8369)
@@ -4288,6 +4288,10 @@
*ecolor* specifies the color of any errorbar
*capsize* (default 3) determines the length in
points of the error bar caps
+ *error_kw* dictionary of kwargs to be passed to
+ errorbar method. *ecolor* and *capsize*
+ may be specified here rather than as
+ independent kwargs.
*align* 'edge' (default) | 'center'
*orientation* 'vertical' | 'horizontal'
*log* [False|True] False (default) leaves the
@@ -4322,13 +4326,18 @@
color = kwargs.pop('color', None)
edgecolor = kwargs.pop('edgecolor', None)
linewidth = kwargs.pop('linewidth', None)
+
# Because xerr and yerr will be passed to errorbar,
# most dimension checking and processing will be left
# to the errorbar method.
xerr = kwargs.pop('xerr', None)
yerr = kwargs.pop('yerr', None)
+ error_kw = kwargs.pop('error_kw', dict())
ecolor = kwargs.pop('ecolor', None)
capsize = kwargs.pop('capsize', 3)
+ error_kw.setdefault('ecolor', ecolor)
+ error_kw.setdefault('capsize', capsize)
+
align = kwargs.pop('align', 'edge')
orientation = kwargs.pop('orientation', 'vertical')
log = kwargs.pop('log', False)
@@ -4478,7 +4487,7 @@
self.errorbar(
x, y,
yerr=yerr, xerr=xerr,
- fmt=None, ecolor=ecolor, capsize=capsize)
+ fmt=None, **error_kw)
self.hold(holdstate) # restore previous hold state
@@ -4833,17 +4842,17 @@
If a scalar number, len(N) array-like object, or an Nx1 array-like
object, errorbars are drawn +/- value.
- If a rank-1, 2xN numpy array, errorbars are drawn at -row1 and
+ If a sequence of shape 2xN, errorbars are drawn at -row1 and
+row2
*fmt*: '-'
- The plot format symbol for *y*. If *fmt* is *None*, just plot the
- errorbars with no line symbols. This can be useful for creating a
- bar plot with errorbars.
+ The plot format symbol. If *fmt* is *None*, only the
+ errorbars are plotted. This is used for adding
+ errorbars to a bar plot, for example.
*ecolor*: [ None | mpl color ]
- a matplotlib color arg which gives the color the errorbar lines; if
- *None*, use the marker color.
+ a matplotlib color arg which gives the color the errorbar lines;
+ if *None*, use the marker color.
*elinewidth*: scalar
the linewidth of the errorbar lines. If *None*, use the linewidth.
@@ -4862,8 +4871,7 @@
type as *xerr* and *yerr*.
All other keyword arguments are passed on to the plot command for the
- markers, so you can add additional key=value pairs to control the
- errorbar markers. For example, this code makes big red squares with
+ markers, For example, this code makes big red squares with
thick green edges::
x,y,yerr = rand(3,10)
@@ -4878,13 +4886,17 @@
%(Line2D)s
- Return value is a length 3 tuple. The first element is the
- :class:`~matplotlib.lines.Line2D` instance for the *y* symbol
- lines. The second element is a list of error bar cap lines,
- the third element is a list of
- :class:`~matplotlib.collections.LineCollection` instances for
- the horizontal and vertical error ranges.
+ Returns (*plotline*, *caplines*, *barlinecols*):
+ *plotline*: :class:`~matplotlib.lines.Line2D` instance
+ *x*, *y* plot markers and/or line
+
+ *caplines*: list of error bar cap
+ :class:`~matplotlib.lines.Line2D` instances
+ *barlinecols*: list of
+ :class:`~matplotlib.collections.LineCollection` instances for
+ the horizontal and vertical error ranges.
+
**Example:**
.. plot:: mpl_examples/pylab_examples/errorbar_demo.py
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
ThinkGeek and WIRED's GeekDad team up for the Ultimate
GeekDad Father's Day Giveaway. ONE MASSIVE PRIZE to the
lucky parental unit. See the prize list and enter to win:
http://p.sf.net/sfu/thinkgeek-promo
_______________________________________________
Matplotlib-checkins mailing list
Matplotlib-checkins@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/matplotlib-checkins
