PlotAxes.hist¶
- PlotAxes.hist(*args, **kwargs)[source]¶
Plot vertical histograms.
- 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.
bins (
int
orlist
offloat
, optional) – The bin count or list of bins.weights (array-like, optional) – The weights associated with each point. If string this can be retrieved from
data
(see below).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
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 default location is used. Valid locations are described incolorbar
.colorbar_kw (dict-like, optional) – Ignored if
colorbar
isNone
. Extra keyword args for the call tocolorbar
.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 default location is used. Valid locations are described inlegend
.legend_kw (dict-like, optional) – Ignored if
legend
isNone
. Extra keyword args for the call tolegend
.**kwargs – Passed to
hist
.
See also