PlotAxes.boxploth¶
- PlotAxes.boxploth(*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
orDataArray
). If passed, positional arguments can optionally be validdata
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
mean, means (
bool
, optional) – IfTrue
, this passesshowmeans=True
andmeanline=True
toboxplot
.fill (
bool
, optional) – Whether to fill the box with a color.fc, facecolor, fillcolor (
color-spec
,list
, optional) – The fill color for the boxes. Default is the next color cycler color. If a list, it should be the same length as the number of objects.a, alpha, fa, facealpha, fillalpha (
float
, optional) – The opacity of the boxes. Default is1.0
. If a list, should be the same length as the number of objects.lw, linewidth, linewidths (
float
, optional) – The linewidth of all objects. Default isrc['patch.linewidth']
=0.6
.c, color, colors, ec, edgecolor, edgecolors (
color-spec
,list
, optional) – The color of all objects. Default is'black'
. If a list, it should be the same length as the number of objects.meanls, medianls, meanlinestyle, medianlinestyle, meanlinestyles, medianlinestyles (
line style-spec
, optional) – The line style for the mean and median lines drawn horizontally across the box.boxc, capc, whiskerc, flierc, meanc, medianc, boxcolor, capcolor, whiskercolor, fliercolor, meancolor, mediancolor boxcolors, capcolors, whiskercolors, fliercolors, meancolors, mediancolors (
color-spec
,list
, optional) – The color of various boxplot components. If a list, it should be the same length as the number of objects. These are shorthands so you don’t have to pass e.g. aboxprops
dictionary.boxlw, caplw, whiskerlw, flierlw, meanlw, medianlw, boxlinewidth, caplinewidth, meanlinewidth, medianlinewidth, whiskerlinewidth, flierlinewidth, boxlinewidths, caplinewidths, meanlinewidths, medianlinewidths, whiskerlinewidths, flierlinewidths (
float
, optional) – The line width of various boxplot components. These are shorthands so you don’t have to pass e.g. aboxprops
dictionary.m, marker (
marker-spec
, optional) – Marker style for the ‘fliers’, i.e. outliers.ms, markersize (
float
, optional) – Marker size for the ‘fliers’, i.e. outliers.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.**kwargs – Passed to
matplotlib.axes.Axes.boxplot
.
See also
PlotAxes.boxes
,PlotAxes.boxesh
,PlotAxes.boxplot
,PlotAxes.boxploth
,matplotlib.axes.Axes.boxplot