matplotlib.axes.Axes.axvspan
-
Axes.axvspan(xmin, xmax, ymin=0, ymax=1, **kwargs)
[source] -
Add a vertical span (rectangle) across the axes.
Draw a vertical span (rectangle) from
xmin
toxmax
. With the default values ofymin
= 0 andymax
= 1. This always spans the yrange, regardless of the ylim settings, even if you change them, e.g., with theset_ylim()
command. That is, the vertical extent is in axes coords: 0=bottom, 0.5=middle, 1.0=top but the x location is in data coordinates.Parameters: -
xmin : scalar
-
Number indicating the first X-axis coordinate of the vertical span rectangle in data units.
-
xmax : scalar
-
Number indicating the second X-axis coordinate of the vertical span rectangle in data units.
-
ymin : scalar, optional
-
Number indicating the first Y-axis coordinate of the vertical span rectangle in relative Y-axis units (0-1). Default to 0.
-
ymax : scalar, optional
-
Number indicating the second Y-axis coordinate of the vertical span rectangle in relative Y-axis units (0-1). Default to 1.
Returns: -
rectangle : matplotlib.patches.Polygon
-
Vertical span (rectangle) from (xmin, ymin) to (xmax, ymax).
Other Parameters: - **kwargs
-
Optional parameters are properties of the class matplotlib.patches.Polygon.
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)
-
© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.0.0/api/_as_gen/matplotlib.axes.Axes.axvspan.html