PlotAxes.boxh¶
- PlotAxes.boxh(*args, **kwargs)[source]¶
Plot horizontal boxes and whiskers with a nice default style.
- 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.
data (dict-like, optional) – A dict-like dataset container (e.g.,
DataFrame
orDataset
). If passed, each data argument can optionally be a stringkey
and the arrays used for plotting are retrieved withdata[key]
. This is a native matplotlib feature.autoformat (
bool
, default:rc.autoformat
=True
) – 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. Formatting ofpint.Quantity
unit strings is controlled byrc.unitformat
='L'
.
- Other Parameters
fill (
bool
, default:True
) – Whether to fill the box with a color.mean, means (
bool
, default:False
) – IfTrue
, this passesshowmeans=True
andmeanline=True
tomatplotlib.axes.Axes.boxplot
. Adds mean lines alongside the median.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
.lw, linewidth, linewidths (
unit-spec
, default:rc['patch.linewidth']
=0.6
) – The edge width of the patch(es). If float, units are points. If string, interpreted byunits
.ls, linestyle, linestyles (
str
, default:'-'
) – The edge style of the patch(es).ec, edgecolor, edgecolors (
color-spec
, default:'black'
) – The edge color of the patch(es).fc, facecolor, facecolors, fillcolor, fillcolors (
color-spec
, optional) – The face color of the patch(es). The propertycycle
is used by default.a, alpha, alphas (
float
, optional) – The opacity of the patch(es). Inferred fromfacecolor
andedgecolor
by default.m, marker, ms, markersize (
float
orstr
, optional) – Marker style and size for the ‘fliers’, i.e. outliers. See theboxplot.flierprops
rcParams
settings.meanls, medianls, meanlinestyle, medianlinestyle, meanlinestyles, medianlinestyles (
str
, optional) – Line style for the mean and median lines drawn across the box. See theboxplot.meanprops
andboxplot.medianprops
rcParams
settings.boxc, capc, whiskerc, flierc, meanc, medianc, boxcolor, capcolor, whiskercolor, fliercolor, meancolor, mediancolor boxcolors, capcolors, whiskercolors, fliercolors, meancolors, mediancolors (
color-spec
or sequence, optional) – Color of various boxplot components. If a sequence, should be the same length as the number of boxes. These are shorthands so you don’t have to pass e.g. aboxprops
dictionary keyword. See theboxplot.boxprops
,boxplot.capprops
,boxplot.whiskerprops
,boxplot.flierprops
,boxplot.meanprops
, andboxplot.medianprops
rcParams
settings.boxlw, caplw, whiskerlw, flierlw, meanlw, medianlw, boxlinewidth, caplinewidth, meanlinewidth, medianlinewidth, whiskerlinewidth, flierlinewidth, boxlinewidths, caplinewidths, meanlinewidths, medianlinewidths, whiskerlinewidths, flierlinewidths (
float
, optional) – Line width of various boxplot components. These are shorthands so you don’t have to pass e.g. aboxprops
dictionary keyword. See theboxplot.boxprops
,boxplot.capprops
,boxplot.whiskerprops
,boxplot.flierprops
,boxplot.meanprops
, andboxplot.medianprops
rcParams
settings.label, value (
float
orstr
, optional) – The single legend label or colorbar coordinate to be used for this plotted element. Can be numeric or string. This is generally used with 1D positional arguments.labels, values (sequence of
float
or sequence 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 positional arguments.**kwargs – Passed to
matplotlib.axes.Axes.boxplot
.
See also
PlotAxes.boxes
,PlotAxes.boxesh
,PlotAxes.boxplot
,PlotAxes.boxploth
,matplotlib.axes.Axes.boxplot