On this page
matplotlib.axes.Axes.errorbar
- Axes.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, *, 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, yfloat or array-like
-
The data positions.
- xerr, yerrfloat 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.
Note that all error arrays should have positive values.
See Different ways of specifying error bars for an example on the usage of
xerrandyerr. - fmtstr, default: ''
-
The format for the data points / data lines. See
plotfor details.Use 'none' (case insensitive) to plot errorbars without any data markers.
- ecolorcolor, default: None
-
The color of the errorbar lines. If None, use the color of the line connecting the markers.
- elinewidthfloat, default: None
-
The linewidth of the errorbar lines. If None, the linewidth of the current style is used.
- capsizefloat, default:
rcParams["errorbar.capsize"](default:0.0) -
The length of the error bar caps in points.
- capthickfloat, 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.
- barsabovebool, default: False
-
If True, will plot the errorbars above the plot symbols. Default is below.
- lolims, uplims, xlolims, xuplimsbool, default: False
-
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 scalars, or array-likes of the same length as xerr and yerr. To use limits with inverted axes,
set_xlimorset_ylimmust be called beforeerrorbar(). Note the tricky parameter names: setting e.g. lolims to True means that the y-value is a lower limit of the True value, so, only an upward-pointing arrow will be drawn! - erroreveryint or (int, int), default: 1
-
draws error bars on a subset of the data. errorevery =N draws error bars on the points (x[::N], y[::N]). errorevery =(start, N) draws error bars on the points (x[start::N], y[start::N]). e.g. errorevery=(6, 3) adds error bars to the data at (x[6], x[9], x[12], x[15], ...). Used to avoid overlapping error bars when two series share x-axis values.
- Returns
-
-
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
-
- dataindexable object, optional
-
If given, the following parameters also accept a string
s, which is interpreted asdata[s](unless this raises an exception):x, y, xerr, yerr
- **kwargs
-
All other keyword arguments are passed on to the
plotcall drawing 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
Line2Dproperties:Property
Description
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
scalar or None
bool
antialiasedor aabool
bool
Patch or (Path, Transform) or None
coloror ccolor
CapStyleor {'butt', 'projecting', 'round'}JoinStyleor {'miter', 'round', 'bevel'}sequence of floats (on/off ink in points) or (None, None)
(2, N) array or two 1D arrays
drawstyleor ds{'default', 'steps', 'steps-pre', 'steps-mid', 'steps-post'}, default: 'default'
{'full', 'left', 'right', 'bottom', 'top', 'none'}
str
bool
object
linestyleor ls{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidthor lwfloat
marker style string,
PathorMarkerStylemarkeredgecoloror meccolor
markeredgewidthor mewfloat
markerfacecoloror mfccolor
markerfacecoloraltor mfcaltcolor
markersizeor msfloat
None or int or (int, int) or slice or list[int] or float or (float, float) or list[bool]
float or callable[[Artist, Event], tuple[bool, dict]]
float
bool
(scale: float, length: float, randomness: float)
bool or None
CapStyleor {'butt', 'projecting', 'round'}JoinStyleor {'miter', 'round', 'bevel'}unknown
str
bool
1D array
1D array
float
Examples using matplotlib.axes.Axes.errorbar
© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.5.1/api/_as_gen/matplotlib.axes.Axes.errorbar.html