matplotlib.pyplot.fill_between — Matplotlib 3.10.1 documentation (original) (raw)
matplotlib.pyplot.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 filled area.
You may exclude some horizontal sections from filling using where.
By default, the edges connect the given points directly. Use step_if the filling should be a step function, i.e. constant in between_x.
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
Define where to exclude some horizontal regions from being filled. The filled regions are defined by the coordinates x[where]. More precisely, fill between x[i] and x[i+1] ifwhere[i] and where[i+1]. Note that this definition implies that an isolated True value between two False values in _where_will not result in filling. Both sides of the True position remain unfilled due to the adjacent False values.
interpolatebool, default: False
This option is only relevant if where is used and the two curves are crossing each other.
Semantically, where is often used for y1 > y2 or similar. By default, the nodes of the polygon defining the filled region will only be placed at the positions in the x array. Such a polygon cannot describe the above semantics close to the intersection. The x-sections containing the intersection are simply clipped.
Setting interpolate to True will calculate the actual intersection point and extend the filled region up to this point.
step{'pre', 'post', 'mid'}, optional
Define step if the filling should be a step function, i.e. constant in between x. The value determines where the step will occur:
- 'pre': The y value is continued constantly to the left from every x position, i.e. the interval
(x[i-1], x[i]]has the valuey[i]. - 'post': The y value is continued constantly to the right from every x position, i.e. the interval
[x[i], x[i+1])has the valuey[i]. - 'mid': Steps occur half-way between the x positions.
Returns:
A FillBetweenPolyCollection containing the plotted polygons.
Other Parameters:
dataindexable object, optional
If given, the following parameters also accept a string s, which is interpreted as data[s] if s is a key in data:
x, y1, y2, where
**kwargs
All other keyword arguments are passed on toFillBetweenPolyCollection. They control the Polygon properties:
See also
Fill between two sets of y-values.
Fill between two sets of x-values.
Notes