PlotAxes.area¶
- PlotAxes.area(*args, **kwargs)[source]¶
Plot individual, grouped, or overlaid shading patches.
- Parameters
*args (
y2
orx
,y2
, orx
,y1
,y2
) – 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, y2.shape[0])
.If only
x
andy2
coordinates are passed, set they1
coordinates to zero. This draws elements originating from the zero line.If both
y1
andy2
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.
data (dict-like, optional) – A dict-like dataset container (e.g.,
DataFrame
orDataArray
). If passed, positional arguments can optionally be stringdata
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
stack, stacked (
bool
, optional) – Whether to “stack” successive columns of they1
array. If this isTrue
andy2
was provided, it will be ignored.negpos (
bool
, optional) – Whether to shade wherey1 >= y2
withposcolor
and wherey1 < y2
withnegcolor
. For example, to shade positive values red and negative values blue, simply useax.fill_between(x, y, negpos=True)
.negcolor, poscolor (
color-spec
, optional) – Colors to use for the negative and positive shaded regions. Ignored ifnegpos
isFalse
. Defaults arerc.negcolor
='blue7'
andrc.poscolor
='red7'
.where (
ndarray
, optional) – Boolean ndarray mask for points you want to shade. See this example.lw, linewidth, linewidths (
float
, optional) – The edge width for the area patches.ec, edgecolor, edgecolors (
color-spec
, optional) – The edge color for the area patches.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 defaultrc['colorbar.loc']
='right'
is used. Valid locations are described incolorbar
.colorbar_kw (dict-like, optional) – Extra keyword args for the call to
colorbar
.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 defaultrc['legend.loc']
='best'
is used. Valid locations are described inlegend
.legend_kw (dict-like, optional) – Extra keyword args for the call to
legend
.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']
.**kwargs – Passed to
fill_between
.