PlotAxes.boxplot

PlotAxes.boxplot(*args, **kwargs)[source]

Plot vertical boxes and whiskers with a nice default style.

Parameters

  • *args (y or x, y) – The data passed as positional or keyword arguments. Interpreted as follows:

    • If only y coordinates are passed, try to infer the x coordinates from the Series or DataFrame indices or the DataArray coordinates. Otherwise, the x coordinates are np.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 with boxplot, violinplot, or when using means=True or medians=True).

    • If any arguments are pint.Quantity, auto-add the pint unit registry to matplotlib’s unit registry using setup_matplotlib. A pint.Quantity embedded in an xarray.DataArray is also supported.

  • data (dict-like, optional) – A dict-like dataset container (e.g., DataFrame or Dataset). If passed, each data argument can optionally be a string key and the arrays used for plotting are retrieved with data[key]. This is a native matplotlib feature.

  • autoformat (bool, optional) – Whether the x axis labels, y axis labels, axis formatters, axes titles, legend titles, and colorbar labels are automatically configured when a Series, DataFrame, DataArray, or Quantity is passed to the plotting command. Default is rc.autoformat = True. Formatting of pint.Quantity unit strings is controlled by rc.unitformat = 'L'.

Other Parameters

  • fill (bool, optional) – Whether to fill the box with a color. Default is True.

  • mean, means (bool, optional) – If True, this passes showmeans=True and meanline=True to matplotlib.axes.Axes.boxplot. Adds mean lines alongside the median.

  • cycle (cycle-spec, optional) – The cycle specifer, passed to the Cycle 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, use cycle=False, cycle='none', or cycle=() (analogous to disabling ticks with e.g. xformatter='none'). To restore the default property cycler, use cycle=True.

  • cycle_kw (dict-like, optional) – Passed to Cycle.

  • lw, linewidth, linewidths (unit-spec, optional) – The edge width of the patch(es). Default is rc['patch.linewidth'] = 0.6. If float, units are points. If string, interpreted by units.

  • 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 property cycle.

  • a, alpha, alphas (float, optional) – The opacity of the patch(es).

  • m, marker, ms, markersize (float or str, optional) – Marker style and size for the ‘fliers’, i.e. outliers. Default is determined by rc['boxplot.flierprops'].

  • 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 or sequence, optional) – The 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. a boxprops 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. a boxprops dictionary.

  • label, value (float or str, 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 of str, 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