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 by set_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:
**kwargsPolygon 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

scalar or None

animated

bool

antialiased or aa

bool or None

capstyle

CapStyle or {'butt', 'projecting', 'round'}

clip_box

Bbox

clip_on

bool

clip_path

Patch or (Path, Transform) or None

closed

bool

color

color

edgecolor or ec

color or None

facecolor or fc

color or None

figure

Figure

fill

bool

gid

str

hatch

{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

in_layout

bool

joinstyle

JoinStyle or {'miter', 'round', 'bevel'}

label

object

linestyle or ls

{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}

linewidth or lw

float or None

mouseover

bool

path_effects

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

xy

(N, 2) array-like

zorder

float

See also

axvspan

Add a vertical span across the Axes.

Examples using matplotlib.axes.Axes.axhspan#