pyrfu.plot.span_tint module#
- pyrfu.plot.span_tint.span_tint(axs, tint, ymin: float = 0, ymax: float = 1, **kwargs)[source]#
Add a vertical span (rectangle) across the time Axes.
The rectangle spans from tint[0] to tint[1] 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:
axs (list of matplotlib.pyplot.subplotsaxes) – Axes to span.
ymin (float) – Lower y-coordinate of the span, in y-axis units (0-1). Default ymin=0.
ymax (float, Optional) – Upper y-coordinate of the span, in y-axis units (0-1). Default ymax=1.
**kwargs – Keyword arguments control the Polygon properties.
- Returns:
axs – List of matplotlib.axes._subplots.AxesSubplot spanned..
- Return type: