PlotAxes.areax¶
- PlotAxes.areax(*args, **kwargs)[source]¶
Plot individual, grouped, or overlaid shading patches.
- Parameters
*args (
x2
ory
,x2
, ory
,x1
,x2
) – 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, x2.shape[0])
.If only
y
andx2
coordinates are passed, set thex1
coordinates to zero. This draws elements originating from the zero line.If both
x1
andx2
are provided, draw elements between these points. If either are 2D, draw elements by iterating over each column.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.
stack, stacked (
bool
, optional) – Whether to “stack” area patches from successive columns of x data or plot area patches on top of each other. Default isFalse
.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
where (
ndarray
, optional) – A boolean mask for the points that should be shaded. See this matplotlib example.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'none'
.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).negpos (
bool
, optional) – Whether to shade patches wherey2 >= y1
withposcolor
and wherey2 < y1
withnegcolor
. Default isFalse
. IfTrue
this function will return a 2-tuple of values.negcolor, poscolor (
color-spec
, optional) – Colors to use for the negative and positive patches. Ignored ifnegpos
isFalse
. Defaults arerc.negcolor
='blue7'
andrc.poscolor
='red7'
.edgefix (
bool
orfloat
, optional) – Whether to fix the common issue where white lines appear between adjacent patches in saved vector graphics (this can slow down figure rendering). See this stackoverflow post for a demonstration of the problem. Default isrc.edgefix
=True
. IfTrue
, a small default linewidth is used to cover up the white lines. If float (e.g.edgefix=0.5
), this specific linewidth is used to cover up the white lines. This feature is automatically disabled when the patches have transparency.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
fill_betweenx
.