vlines
- mdtools.plot.vlines(ax, x, start, stop, xmin=None, xmax=None, ymin=None, ymax=None, legend_loc='best', **kwargs)[source]
Plot vertical lines at each x from start to stop into a
matplotlib.axes.Axes
object usingmatplotlib.axes.Axes.vlines()
.Deprecated since version 0.0.0.dev2: Use
matplotlib.axes.Axes.vlines()
,matplotlib.axes.Axes.set()
andmatplotlib.axes.Axes.legend()
directly.- Parameters:
ax (
matplotlib.axes.Axes
) – The axes to draw to.x (
scalar
orarray_like
) – x-indices where to plot the lines.start, stop (
scalar
orarray_like
) – Respective beginning and end of each line. If scalars are provided, all lines will have same length.xmin (
scalar
, optional) – Left limit for plotting on x-axis. The left limit may be greater than the right limit, in which case the tick values will show up in decreasing order. Default isNone
, which means set the limit automatically.xmax (
scalar
, optional) – Right limit for plotting on x-axis.ymin, ymax (
scalar
, optional) – Same as xmin and xmax, but for the y-axis.legend_loc (
int
orstr
, optional) – Position of the legend. Seematplotlib.pyplot.legend()
for possible arguments.kwargs (
dict
, optional) – Keyword arguments to pass tomatplotlib.axes.Axes.vlines()
. See there for possible keyword arguments.
- Returns:
img (
matplotlib.collections.LineCollection
) – Amatplotlib.collections.LineCollection
.