matplotlib.pyplot.barh#
- matplotlib.pyplot.barh(y,width,height=0.8,left=None,*,align='center',data=None,**kwargs)[source]#
Make a horizontal bar plot.
The bars are positioned aty with the givenalignment. Theirdimensions are given bywidth andheight. The horizontal baselineisleft (default 0).
Many parameters can take either a single value applying to all barsor a sequence of values, one for each bar.
- Parameters:
- yfloat or array-like
The y coordinates of the bars. See alsoalign for thealignment of the bars to the coordinates.
Bars are often used for categorical data, i.e. string labels belowthe bars. You can provide a list of strings directly toy.
barh(['A','B','C'],[1,2,3])
is often a shorter and moreconvenient notation compared tobarh(range(3),[1,2,3],tick_label=['A','B','C'])
. They areequivalent as long as the names are unique. The explicittick_labelnotation draws the names in the sequence given. However, when havingduplicate values in categoricaly data, these values map to the samenumerical y coordinate, and hence the corresponding bars are drawn ontop of each other.- widthfloat or array-like
The width(s) of the bars.
Note that ifleft has units (e.g. datetime),width should be inunits that are a difference from the value ofleft (e.g. timedelta).
- heightfloat or array-like, default: 0.8
The heights of the bars.
Note that ify has units (e.g. datetime), thenheight should be inunits that are a difference (e.g. timedelta) around they values.
- leftfloat or array-like, default: 0
The x coordinates of the left side(s) of the bars.
Note that ifleft has units, then the x-axis will get a Locator andFormatter appropriate for the units (e.g. dates, or categorical).
- align{'center', 'edge'}, default: 'center'
Alignment of the base to they coordinates*:
'center': Center the bars on they positions.
'edge': Align the bottom edges of the bars with theypositions.
To align the bars on the top edge pass a negativeheight and
align='edge'
.
- Returns:
BarContainer
Container with all the bars and optionally errorbars.
- Other Parameters:
- colorcolor or list ofcolor, optional
The colors of the bar faces.
- edgecolorcolor or list ofcolor, optional
The colors of the bar edges.
- linewidthfloat or array-like, optional
Width of the bar edge(s). If 0, don't draw edges.
- tick_labelstr or list of str, optional
The tick labels of the bars.Default: None (Use default numeric labels.)
- labelstr or list of str, optional
A single label is attached to the resulting
BarContainer
as alabel for the whole dataset.If a list is provided, it must be the same length asy andlabels the individual bars. Repeated labels are not de-duplicatedand will cause repeated label entries, so this is best used whenbars also differ in style (e.g., by passing a list tocolor.)- xerr, yerrfloat or array-like of shape(N,) or shape(2, N), optional
If notNone, add horizontal / vertical errorbars to the bar tips.The values are +/- sizes relative to the data:
scalar: symmetric +/- values for all bars
shape(N,): symmetric +/- values for each bar
shape(2, N): Separate - and + values for each bar. First rowcontains the lower errors, the second row contains the uppererrors.
None: No errorbar. (default)
SeeDifferent ways of specifying error bars for an example onthe usage ofxerr andyerr.
- ecolorcolor or list ofcolor, default: 'black'
The line color of the errorbars.
- capsizefloat, default:
rcParams["errorbar.capsize"]
(default:0.0
) The length of the error bar caps in points.
- error_kwdict, optional
Dictionary of keyword arguments to be passed to the
errorbar
method. Values ofecolor orcapsize definedhere take precedence over the independent keyword arguments.- logbool, default: False
If
True
, set the x-axis to be log scale.- dataindexable object, optional
If given, all parameters also accept a string
s
, which isinterpreted asdata[s]
ifs
is a key indata
.- **kwargs
Rectangle
properties Property
Description
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image
float or None
unknown
bool
bool or None
(left, bottom, width, height)
CapStyle
or {'butt', 'projecting', 'round'}BboxBase
or Nonebool
Patch or (Path, Transform) or None
color or None
color or None
bool
str
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
unknown
color or 'edge' or None
unknown
bool
JoinStyle
or {'miter', 'round', 'bevel'}object
{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
float or None
bool
list of
AbstractPathEffect
None or bool or float or callable
bool
(scale: float, length: float, randomness: float)
bool or None
str
bool
unknown
unknown
(float, float)
unknown
float
See also
bar
Plot a vertical bar plot.
Notes
Note
This is thepyplot wrapper for
axes.Axes.barh
.Stacked bars can be achieved by passing individualleft values perbar. SeeDiscrete distribution as horizontal bar chart.