matplotlib.axes.Axes.axhspan#
- Axes.axhspan(ymin, ymax, xmin=0, xmax=1, **kwargs)[source]#
Add a horizontal span (rectangle) across the Axes.
The rectangle spans from ymin to ymax vertically, and, by default, the whole x-axis horizontally. The x-span can be set using xmin (default: 0) and xmax (default: 1) which are in axis units; e.g.
xmin = 0.5
always refers to the middle of the x-axis regardless of the limits set byset_xlim
.- Parameters:
- yminfloat
Lower y-coordinate of the span, in data units.
- ymaxfloat
Upper y-coordinate of the span, in data units.
- xminfloat, default: 0
Lower x-coordinate of the span, in x-axis (0-1) units.
- xmaxfloat, default: 1
Upper x-coordinate of the span, in x-axis (0-1) units.
- Returns:
Polygon
Horizontal span (rectangle) from (xmin, ymin) to (xmax, ymax).
- Other Parameters:
- **kwargs
Polygon
properties 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
scalar or None
bool
antialiased
or aabool or None
CapStyle
or {'butt', 'projecting', 'round'}bool
Patch or (Path, Transform) or None
bool
color
edgecolor
or eccolor or None
facecolor
or fccolor or None
bool
str
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
bool
JoinStyle
or {'miter', 'round', 'bevel'}object
linestyle
or ls{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth
or lwfloat or None
bool
None or bool or float or callable
bool
(scale: float, length: float, randomness: float)
bool or None
str
bool
(N, 2) array-like
float
- **kwargs
See also
axvspan
Add a vertical span across the Axes.