matplotlib.axes.Axes.fill_between#
- Axes.fill_between(x,y1,y2=0,where=None,interpolate=False,step=None,*,data=None,**kwargs)[source]#
Fill the area between two horizontal curves.
The curves are defined by the points (x,y1) and (x,y2). This creates one or multiple polygons describing the filledarea.
You may exclude some horizontal sections from filling usingwhere.
By default, the edges connect the given points directly. Usestepif the filling should be a step function, i.e. constant in betweenx.
- Parameters:
- xarray-like
The x coordinates of the nodes defining the curves.
- y1array-like or float
The y coordinates of the nodes defining the first curve.
- y2array-like or float, default: 0
The y coordinates of the nodes defining the second curve.
- wherearray-like of bool, optional
Definewhere to exclude some horizontal regions from being filled.The filled regions are defined by the coordinates
x[where].More precisely, fill betweenx[i]andx[i+1]ifwhere[i]andwhere[i+1]. Note that this definition impliesthat an isolatedTrue value between twoFalse values inwherewill not result in filling. Both sides of theTrue positionremain unfilled due to the adjacentFalse values.- interpolatebool, default: False
This option is only relevant ifwhere is used and the two curvesare crossing each other.
Semantically,where is often used fory1 >y2 orsimilar. By default, the nodes of the polygon defining the filledregion will only be placed at the positions in thex array.Such a polygon cannot describe the above semantics close to theintersection. The x-sections containing the intersection aresimply clipped.
Settinginterpolate toTrue will calculate the actualintersection point and extend the filled region up to this point.
- step{'pre', 'post', 'mid'}, optional
Definestep if the filling should be a step function,i.e. constant in betweenx. The value determines where thestep will occur:
'pre': The y value is continued constantly to the left fromeveryx position, i.e. the interval
(x[i-1],x[i]]has the valuey[i].'post': The y value is continued constantly to the right fromeveryx position, i.e. the interval
[x[i],x[i+1])has the valuey[i].'mid': Steps occur half-way between thex positions.
- Returns:
FillBetweenPolyCollectionA
FillBetweenPolyCollectioncontaining the plotted polygons.
- Other Parameters:
- dataindexable object, optional
If given, the following parameters also accept a string
s, which isinterpreted asdata[s]ifsis a key indata:x,y1,y2,where
- **kwargs
All other keyword arguments are passed on to
FillBetweenPolyCollection. They control thePolygonproperties:Property
Description
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image
array-like or float or None
bool
bool or list of bools
array-like or None
CapStyleor {'butt', 'projecting', 'round'}(vmin: float, vmax: float)
BboxBaseor Nonebool
Patch or (Path, Transform) or None
Colormapor str or Nonecolor or list of RGBA tuples
array-like
edgecolororecoredgecolorsfacecolororfacecolorsorfcstr
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
unknown
bool
JoinStyleor {'miter', 'round', 'bevel'}object
linestyleordashesorlinestylesorlsstr or tuple or list thereof
linewidthorlinewidthsorlwfloat or list of floats
bool
Normalizeor str or None(N, 2) or (2,) array-like
list of
AbstractPathEffectlist of array-like
None or bool or float or callable
float
bool
sizesnumpy.ndarrayor None(scale: float, length: float, randomness: float)
bool or None
str
list of str or None
list of array-like
unknown
bool
float
See also
fill_betweenFill between two sets of y-values.
fill_betweenxFill between two sets of x-values.
Examples usingmatplotlib.axes.Axes.fill_between#
Shade regions defined by a logical mask using fill_between