PlotAxes.barh¶
- PlotAxes.barh(*args, **kwargs)[source]¶
Plot individual, grouped, or stacked bars.
- Parameters
*args (
x
ory
,x
) – The data passed as positional or keyword arguments. Interpreted as follows:If only
x
coordinates are passed, try to infer they
coordinates from theSeries
orDataFrame
indices or theDataArray
coordinates. Otherwise, they
coordinates arenp.arange(0, x.shape[0])
.If the
x
coordinates are a 2D array, plot each column of data in succession (except where each column of data represents a statistical distribution, as withboxplot
,violinplot
, or when usingmeans=True
ormedians=True
).If any arguments are
pint.Quantity
, auto-add the pint unit registry to matplotlib’s unit registry usingsetup_matplotlib
. Apint.Quantity
embedded in anxarray.DataArray
is also supported.
width (
float
or array-like, optional) – The width(s) of the bars relative to the y coordinate step size. Can be passed as a third positional argument.left (
float
or array-like, optional) – The coordinate(s) of the left edge of the bars. Default is0
. Can be passed as a fourth positinal argument.absolute_width (
bool
, optional) – Whether to make thewidth
units absolute. IfTrue
, this restores the default matplotlib behavior. Default isFalse
.data (dict-like, optional) – A dict-like dataset container (e.g.,
DataFrame
orDataArray
). If passed, positional arguments can optionally be stringdata
keys and the arrays used for plotting are retrieved withdata[key]
. This is a native matplotlib feature.autoformat (
bool
, optional) – Whether thex
axis labels,y
axis labels, axis formatters, axes titles, legend titles, and colorbar labels are automatically configured when aSeries
,DataFrame
,DataArray
, orQuantity
is passed to the plotting command. Default isrc.autoformat
=True
.
- Other Parameters
stack, stacked (
bool
, optional) – Whether to stack columns of the input array or plot the bars side-by-side in groups.negpos (
bool
, optional) – Whether to shade bars greater than zero withposcolor
and bars less than zero withnegcolor
.negcolor, poscolor (
color-spec
, optional) – Colors to use for the negative and positive bars. Ignored ifnegpos
isFalse
. Defaults arerc.negcolor
='blue7'
andrc.poscolor
='red7'
.lw, linewidth, linewidths (
float
, optional) – The edge width for the bar patches.ec, edgecolor, edgecolors (
color-spec
, optional) – The edge color for the bar patches.cycle (
cycle-spec
, optional) – The cycle specifer, passed to theCycle
constructor. If the returned cycler is unchanged from the current cycler, the axes cycler will not be reset to its first position. To disable property cycling and just use black for the default color, usecycle=False
,cycle='none'
, orcycle=()
(analogous to disabling ticks with e.g.xformatter='none'
). To restore the default property cycler, usecycle=True
.label, value (
float
orstr
, optional) – The single legend label or colorbar coordinate to be used for this plotted element. This is generally used with 1D input coordinates.labels, values (
list
offloat
orlist
ofstr
, optional) – The legend labels or colorbar coordinates used for each plotted element. Can be numeric or string, and must match the number of plotted elements. This is generally used with 2D input coordinates.colorbar (
bool
,int
, orstr
, optional) – If notNone
, this is a location specifying where to draw an inset or panel colorbar from the resulting object(s). IfTrue
, the defaultrc['colorbar.loc']
='right'
is used. Valid locations are described incolorbar
.colorbar_kw (dict-like, optional) – Extra keyword args for the call to
colorbar
.legend (
bool
,int
, orstr
, optional) – If notNone
, this is a location specifying where to draw an inset or panel legend from the resulting object(s). IfTrue
, the defaultrc['legend.loc']
='best'
is used. Valid locations are described inlegend
.legend_kw (dict-like, optional) – Extra keyword args for the call to
legend
.mean, means (
bool
, optional) – Whether to plot the means of each column for 2Dx
coordinates. Means are calculated withnumpy.nanmean
. If no other arguments are specified, this also setsbarstd=True
(andboxstd=True
for violin plots).median, medians (
bool
, optional) – Whether to plot the medians of each column for 2Dx
coordinates. Medians are calculated withnumpy.nanmedian
. If no other arguments arguments are specified, this also setsbarstd=True
(andboxstd=True
for violin plots).barstd, barstds (
bool
,float
, or2-tuple
offloat
, optional) – Valid only if `mean` or `median` is ``True``. Standard deviation multiples for thin error bars with optional whiskers (i.e., caps). If scalar, then +/- that multiple is used. IfTrue
, the default standard deviation range of +/-3 is used.barpctile, barpctiles (
bool
,float
, or2-tuple
offloat
, optional) – Valid only if `mean` or `median` is ``True``. As withbarstd
, but instead using percentiles for the error bars. If scalar, that percentile range is used (e.g.,90
shows the 5th to 95th percentiles). IfTrue
, the default percentile range of 0 to 100 is used.bardata (
2 x N array
or1D array
, optional) – Valid only if `mean` and `median` are ``False``. If shape is 2 x N, these are the lower and upper bounds for the thin error bars. If shape is N, these are the absolute, symmetric deviations from the central points.boxstd, boxstds, boxpctile, boxpctiles, boxdata (optional) – As with
barstd
,barpctile
, andbardata
, but for thicker error bars representing a smaller interval than the thin error bars. Ifboxstd
isTrue
, the default standard deviation range of +/-1 is used. Ifboxpctiles
isTrue
, the default percentile range of 25 to 75 is used (i.e., the interquartile range). When “boxes” and “bars” are combined, this has the effect of drawing miniature box-and-whisker plots.capsize (
float
, optional) – The cap size for thin error bars in points. Default isrc['errorbar.capsize']
=3.0
.barz, barzorder, boxz, boxzorder (
float
, optional) – The “zorder” for the thin and thick error bars. Default is2.5
.barc, barcolor, boxc, boxcolor (
color-spec
, optional) – Colors for the thin and thick error bars. Default isrc['boxplot.whiskerprops.color']
='black'
.barlw, barlinewidth, boxlw, boxlinewidth (
float
, optional) – Line widths for the thin and thick error bars, in points. The defaultsrc['boxplot.whiskerprops.linewidth']
=1.0
(bars) and four times that value (boxes).boxm, boxmarker (
bool
ormarker-spec
, optional) – Whether to draw a small marker in the middle of the box denoting the mean or median position. Ignored ifboxes
isFalse
. Default is'o'
.boxms, boxmarkersize (
size-spec
, optional) – The marker size for theboxmarker
marker in points ** 2. Default size is equal to(2 * boxlinewidth) ** 2
.boxmc, boxmarkercolor, boxmec, boxmarkeredgecolor (
color-spec
, optional) – Color, face color, and edge color for theboxmarker
marker. Default color and edge color are'w'
.inbounds (
bool
, optional) – Whether to restrict the defaulty
(x
) axis limits to account for only in-bounds data when thex
(y
) axis limits have been locked. Default isrc['axes.inbounds']
=True
. See alsorc['cmap.inbounds']
.**kwargs – Passed to
barh
.