On this page
matplotlib.pyplot.errorbar
matplotlib.pyplot.errorbar(x, y, yerr=None, xerr=None, fmt='', ecolor=None, elinewidth=None, capsize=None, barsabove=False, lolims=False, uplims=False, xlolims=False, xuplims=False, errorevery=1, capthick=None, hold=None, data=None, **kwargs)[source]-
Plot y versus x as lines and/or markers with attached errorbars.
x, y define the data locations, xerr, yerr define the errorbar sizes. By default, this draws the data markers/lines as well the errorbars. Use fmt='none' to draw errorbars without any data markers.
Parameters: -
x, y : scalar or array-like -
The data positions.
-
xerr, yerr : scalar or array-like, shape(N,) or shape(2,N), optional -
The errorbar sizes:
- scalar: Symmetric +/- values for all data points.
- shape(N,): Symmetric +/-values for each data point.
-
- shape(2,N): Separate - and + values for each bar. First row
- contains the lower errors, the second row contains the upper errors.
- None: No errorbar.
See Different ways of specifying error bars for an example on the usage of
xerrandyerr. -
fmt : plot format string, optional, default: '' -
The format for the data points / data lines. See
plotfor details.Use 'none' (case insensitive) to plot errorbars without any data markers.
-
ecolor : mpl color, optional, default: None -
A matplotlib color arg which gives the color the errorbar lines. If None, use the color of the line connecting the markers.
-
elinewidth : scalar, optional, default: None -
The linewidth of the errorbar lines. If None, the linewidth of the current style is used.
-
capsize : scalar, optional, default: None -
The length of the error bar caps in points. If None, it will take the value from
rcParams["errorbar.capsize"]. -
capthick : scalar, optional, default: None -
An alias to the keyword argument markeredgewidth (a.k.a. mew). This setting is a more sensible name for the property that controls the thickness of the error bar cap in points. For backwards compatibility, if mew or markeredgewidth are given, then they will over-ride capthick. This may change in future releases.
-
barsabove : bool, optional, default: False -
If True, will plot the errorbars above the plot symbols. Default is below.
-
lolims, uplims, xlolims, xuplims : bool, optional, default: None -
These arguments can be used to indicate that a value gives only upper/lower limits. In that case a caret symbol is used to indicate this. lims-arguments may be of the same type as xerr and yerr. To use limits with inverted axes,
set_xlim()orset_ylim()must be called beforeerrorbar(). -
errorevery : positive integer, optional, default: 1 -
Subsamples the errorbars. e.g., if errorevery=5, errorbars for every 5-th datapoint will be plotted. The data plot itself still shows all data points.
Returns: -
container : ErrorbarContainer -
The container contains:
- plotline:
Line2Dinstance of x, y plot markers and/or line. - caplines: A tuple of
Line2Dinstances of the error bar caps. - barlinecols: A tuple of
LineCollectionwith the horizontal and vertical error ranges.
- plotline:
Other Parameters: - **kwargs :
-
All other keyword arguments are passed on to the plot command for the markers. For example, this code makes big red squares with thick green edges:
x,y,yerr = rand(3,10) errorbar(x, y, yerr, marker='s', mfc='red', mec='green', ms=20, mew=4)where mfc, mec, ms and mew are aliases for the longer property names, markerfacecolor, markeredgecolor, markersize and markeredgewidth.
Valid kwargs for the marker properties are
Lines2Dproperties:Property Description agg_filtera filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array alphafloat (0.0 transparent through 1.0 opaque) animatedbool antialiasedor aabool clip_boxa Bboxinstanceclip_onbool clip_path[( Path,Transform) |Patch| None]coloror cany matplotlib color containsa callable function dash_capstyle['butt' | 'round' | 'projecting'] dash_joinstyle['miter' | 'round' | 'bevel'] dashessequence of on/off ink in points drawstyle['default' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post'] figurea Figureinstancefillstyle['full' | 'left' | 'right' | 'bottom' | 'top' | 'none'] gidan id string labelobject linestyleor ls['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) | '-'|'--'|'-.'|':'|'None'|' '|'']linewidthor lwfloat value in points markerA valid marker stylemarkeredgecoloror mecany matplotlib color markeredgewidthor mewfloat value in points markerfacecoloror mfcany matplotlib color markerfacecoloraltor mfcaltany matplotlib color markersizeor msfloat markevery[None | int | length-2 tuple of int | slice | list/array of int | float | length-2 tuple of float] path_effectsAbstractPathEffectpickerfloat distance in points or callable pick function fn(artist, event)pickradiusfloat distance in points rasterizedbool or None sketch_params(scale: float, length: float, randomness: float) snapbool or None solid_capstyle['butt' | 'round' | 'projecting'] solid_joinstyle['miter' | 'round' | 'bevel'] transforma matplotlib.transforms.Transforminstanceurla url string visiblebool xdata1D array ydata1D array zorderfloat
Notes
Note
In addition to the above described arguments, this function can take a data keyword argument. If such a data argument is given, the following arguments are replaced by data[<arg>]:
- All arguments with the following names: 'x', 'xerr', 'y', 'yerr'.
-
Examples using matplotlib.pyplot.errorbar
© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/2.2.3/api/_as_gen/matplotlib.pyplot.errorbar.html