matplotlib.pyplot.axhspan#

matplotlib.pyplot.axhspan(ymin,ymax,xmin=0,xmax=1,**kwargs)[source]#

Add a horizontal span (rectangle) across the Axes.

The rectangle spans fromymin toymax vertically, and, by default,the whole x-axis horizontally. The x-span can be set usingxmin(default: 0) andxmax (default: 1) which are in axis units; e.g.xmin=0.5 always refers to the middle of the x-axis regardless ofthe 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:

Rectangle

Horizontal 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 oraa	bool or None
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 orec	color or None
facecolor orfc	color or None
figure	Figure orSubFigure
fill	bool
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 orls	{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth orlw	float or None
mouseover	bool
path_effects	list ofAbstractPathEffect
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

axvspan

Add a vertical span across the Axes.

Notes

Note

This is thepyplot wrapper foraxes.Axes.axhspan.

Examples usingmatplotlib.pyplot.axhspan#

Draw regions that span an Axes

Draw regions that span an Axes