PlotAxes.stepx¶
- PlotAxes.stepx(*args, **kwargs)[source]¶
Plot step lines.
- 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
, 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 width of the line(s). Default isrc['lines.linewidth']
=1.5
. If float, units are points. If string, interpreted byunits
.ls, linestyle, linestyles (
str
, optional) – The style of the line(s). Default isrc['lines.linestyle']
='-'
.c, color, colors (
color-spec
, optional) – The color of the line(s). Default is to use the propertycycle
.a, alpha, alphas (
float
, optional) – The opacity of the line(s).inbounds (
bool
, optional) – Whether to restrict the defaulty
(x
) axis limits to account for only in-bounds data when thex
(y
) axis limits have been locked. Default isrc['axes.inbounds']
=True
. See alsorc['cmap.inbounds']
.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.colorbar (
bool
,int
, orstr
, optional) – If notNone
, this is a location specifying where to draw an inset or outer colorbar from the resulting object(s). IfTrue
, the defaultrc['colorbar.loc']
='right'
is used. If the same location is used in successive plotting calls, object(s) will be added to the existing colorbar in that location (valid for colorbars built from lists of artists). Valid locations are shown in incolorbar
.colorbar_kw (dict-like, optional) – Extra keyword args for the call to
colorbar
.legend (
bool
,int
, orstr
, optional) – Location specifying where to draw an inset or outer legend from the resulting object(s). IfTrue
, the defaultrc['legend.loc']
='best'
is used. If the same location is used in successive plotting calls, object(s) will be added to existing legend in that location. Valid locations are shown inlegend
.legend_kw (dict-like, optional) – Extra keyword args for the call to
legend
.**kwargs – Passed to
step
.
See also