matplotlib.axes.Axes.axvspan#
- Axes.axvspan(xmin, xmax, ymin=0, ymax=1, **kwargs)[source]#
Add a vertical span (rectangle) across the Axes.
The rectangle spans from xmin to xmax horizontally, and, by default, the whole y-axis vertically. The y-span can be set using ymin (default: 0) and ymax (default: 1) which are in axis units; e.g.
ymin = 0.5
always refers to the middle of the y-axis regardless of the limits set byset_ylim
.- Parameters:
- xminfloat
Lower x-coordinate of the span, in data units.
- xmaxfloat
Upper x-coordinate of the span, in data units.
- yminfloat, default: 0
Lower y-coordinate of the span, in y-axis units (0-1).
- ymaxfloat, default: 1
Upper y-coordinate of the span, in y-axis units (0-1).
- Returns:
Polygon
Vertical 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
axhspan
Add a horizontal span across the Axes.
Examples
Draw a vertical, green, translucent rectangle from x = 1.25 to x = 1.55 that spans the yrange of the Axes.
>>> axvspan(1.25, 1.55, facecolor='g', alpha=0.5)