PlotAxes.areax¶

PlotAxes.areax(*args, **kwargs)[source]¶

Plot individual, grouped, or overlaid shading patches.

Parameters

*args (x2 or y, x2, or y, x1, x2) – The data passed as positional or keyword arguments. Interpreted as follows:
- If only x coordinates are passed, try to infer the y coordinates from the Series or DataFrame indices or the DataArray coordinates. Otherwise, the y coordinates are np.arange(0, x2.shape[0]).
- If only y and x2 coordinates are passed, set the x1 coordinates to zero. This draws elements originating from the zero line.
- If both x1 and x2 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 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 DataArray). If passed, positional arguments can optionally be string data keys 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.

Other Parameters

stack, stacked (bool, optional) – Whether to “stack” successive columns of the x1 array. If this is True and x2 was provided, it will be ignored.
negpos (bool, optional) – Whether to shade where x1 >= x2 with poscolor and where x1 < x2 with negcolor. For example, to shade positive values red and negative values blue, simply use ax.fill_betweenx(y, x, negpos=True).
negcolor, poscolor (color-spec, optional) – Colors to use for the negative and positive shaded regions. Ignored if negpos is False. Defaults are rc.negcolor = 'blue7' and rc.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 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.
label, value (float or str, 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 of float or list 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 input coordinates.
colorbar (bool, int, or str, optional) – If not None, this is a location specifying where to draw an inset or panel colorbar from the resulting object(s). If True, the default rc['colorbar.loc'] = 'right' is used. Valid locations are described in colorbar.
colorbar_kw (dict-like, optional) – Extra keyword args for the call to colorbar.
legend (bool, int, or str, optional) – If not None, this is a location specifying where to draw an inset or panel legend from the resulting object(s). If True, the default rc['legend.loc'] = 'best' is used. Valid locations are described in legend.
legend_kw (dict-like, optional) – Extra keyword args for the call to legend.
inbounds (bool, optional) – Whether to restrict the default y (x) axis limits to account for only in-bounds data when the x (y) axis limits have been locked. Default is rc['axes.inbounds'] = True. See also rc['cmap.inbounds'].
**kwargs – Passed to fill_betweenx.