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 ~.Axes.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¶

~matplotlib.patches.Polygon

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

Other Parameters¶

**kwargs : ~matplotlib.patches.Polygon properties

Properties:

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: ~matplotlib.transforms.BboxBase or None clip_on: bool clip_path: Patch or (Path, Transform) or None closed: bool color: :mpltype:`color` edgecolor or ec: :mpltype:`color` or None facecolor or fc: :mpltype:`color` or None figure: ~matplotlib.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: 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: ~matplotlib.transforms.Transform url: str visible: bool xy: (N, 2) array-like zorder: float

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)