PlotAxes.violinplot¶
- PlotAxes.violinplot(*args, **kwargs)[source]¶
Plot vertical violins with a nice default style matching this matplotlib example.
- Parameters
*args (
y
orx
,y
) – The data passed as positional or keyword arguments. Interpreted as follows:If only
y
coordinates are passed, try to infer thex
coordinates from theSeries
orDataFrame
indices or theDataArray
coordinates. Otherwise, thex
coordinates arenp.arange(0, y.shape[0])
.If the
y
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
, 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
. Formatting ofpint.Quantity
unit strings is controlled byrc.unitformat
='L'
.
- Other Parameters
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
, optional) – The edge width of the patch(es). Default isrc['patch.linewidth']
=0.6
. If float, units are points. If string, interpreted byunits
.ls, linestyle, linestyles (
str
, optional) – The edge style of the patch(es). Default is'-'
.ec, edgecolor, edgecolors (
color-spec
, optional) – The edge color of the patch(es). Default is'black'
.fc, facecolor, facecolors, fillcolor, fillcolors (
color-spec
, optional) – The face color of the patch(es). Default is to use the propertycycle
.a, alpha, alphas (
float
, optional) – The opacity of the patch(es).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.showmeans, showmedians (
bool
, optional) – Interpreted asmeans=True
andmedians=True
when passed.showextrema (
bool
, optional) – Interpreted asbarpctiles=True
when passed (i.e. shows minima and maxima).bars (
bool
, optional) – Shorthand forbarstd
,barstds
.barstd, barstds (
bool
,float
, or2-tuple
offloat
, optional) – Valid only ifmean
ormedian
isTrue
. 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 ifmean
ormedian
isTrue
. 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 (array-like, optional) – Valid only if
mean
andmedian
areFalse
. 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.boxes (
bool
, optional) – Shorthand forboxstd
,boxstds
.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. Ifboxstds
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'
.**kwargs – Passed to
matplotlib.axes.Axes.violinplot
.