matplotlib.pyplot.axvspan#

matplotlib.pyplot.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 by set_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:

Rectangle

Vertical span (rectangle) from (xmin, ymin) to (xmax, ymax).

Other Parameters:

**kwargsRectangle properties

Property	Description
agg_filter	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
alpha	float or None
angle	unknown
animated	bool
antialiased or aa	bool or None
blend_mode	blend mode
bounds	(left, bottom, width, height)
capstyle	CapStyle or {'butt', 'projecting', 'round'}
clip_box	BboxBase or None
clip_on	bool
clip_path	Patch or (Path, Transform) or None
color	color
edgecolor or ec	color or None
edgegapcolor	color or None
facecolor or fc	color or None
figure	Figure or SubFigure
fill	bool
fill_rule	{'nonzero', 'evenodd'}
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
hatch_linewidth	unknown
hatchcolor	color or 'edge' or None
height	unknown
in_layout	bool
joinstyle	JoinStyle or {'miter', 'round', 'bevel'}
label	object
linestyle or ls	linestyle
linewidth or lw	float or None
mouseover	bool
path_effects	list of AbstractPathEffect
picker	None or bool or float or callable
rasterized	bool
sketch_params	(scale: float, length: float, randomness: float)
snap	bool or None
transform	Transform
url	str
visible	bool
width	unknown
x	unknown
xy	(float, float)
y	unknown
zorder	float

See also

axhspan

Add a horizontal span across the Axes.

Notes

Note

This is the pyplot wrapper for axes.Axes.axvspan.

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)

Examples using matplotlib.pyplot.axvspan#

[]

Draw regions that span an Axes

Draw regions that span an Axes