On this page
matplotlib.axes.Axes.barh
- Axes.barh(y, width, height=0.8, left=None, *, align='center', **kwargs)[source]
-
Make a horizontal bar plot.
The bars are positioned at y with the given alignment. Their dimensions are given by width and height. The horizontal baseline is left (default 0).
Many parameters can take either a single value applying to all bars or a sequence of values, one for each bar.
- Parameters
-
- yfloat or array-like
-
The y coordinates of the bars. See also align for the alignment of the bars to the coordinates.
- widthfloat or array-like
-
The width(s) of the bars.
- heightfloat or array-like, default: 0.8
-
The heights of the bars.
- leftfloat or array-like, default: 0
-
The x coordinates of the left sides of the bars.
- align{'center', 'edge'}, default: 'center'
-
Alignment of the base to the y coordinates*:
- 'center': Center the bars on the y positions.
- 'edge': Align the bottom edges of the bars with the y positions.
To align the bars on the top edge pass a negative height and
align='edge'
.
- Returns
-
-
BarContainer
-
Container with all the bars and optionally errorbars.
-
- Other Parameters
-
- colorcolor or list of color, optional
-
The colors of the bar faces.
- edgecolorcolor or list of color, 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.)
- xerr, yerrfloat or array-like of shape(N,) or shape(2, N), optional
-
If not
None
, 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 row contains the lower errors, the second row contains the upper errors.
- None: No errorbar. (default)
See Different ways of specifying error bars for an example on the usage of
xerr
andyerr
. - ecolorcolor or list of color, 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 kwargs to be passed to the
errorbar
method. Values of ecolor or capsize defined here take precedence over the independent kwargs. - logbool, default: False
-
If
True
, set the x-axis to be log scale. - **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
scalar or None
unknown
bool
antialiased
or aabool or None
(left, bottom, width, height)
CapStyle
or {'butt', 'projecting', 'round'}bool
Patch or (Path, Transform) or None
color
edgecolor
or eccolor or None
facecolor
or fccolor or None
bool
str
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
unknown
bool
JoinStyle
or {'miter', 'round', 'bevel'}object
linestyle
or ls{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth
or lwfloat or None
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
Stacked bars can be achieved by passing individual left values per bar. See Discrete distribution as horizontal bar chart .
Examples using matplotlib.axes.Axes.barh
© 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.barh.html