Module « matplotlib.pyplot »

Fonction vlines - module matplotlib.pyplot

Signature de la fonction vlines

def vlines(x, ymin, ymax, colors=None, linestyles='solid', label='', *, data=None, **kwargs) 

Description

vlines.__doc__

Plot vertical lines at each *x* from *ymin* to *ymax*.

Parameters
----------
x : float or array-like
    x-indexes where to plot the lines.

ymin, ymax : float or array-like
    Respective beginning and end of each line. If scalars are
    provided, all lines will have same length.

colors : list of colors, default: :rc:`lines.color`

linestyles : {'solid', 'dashed', 'dashdot', 'dotted'}, optional

label : str, default: ''

Returns
-------
`~matplotlib.collections.LineCollection`

Other Parameters
----------------
**kwargs : `~matplotlib.collections.LineCollection` properties.

See Also
--------
hlines : horizontal lines
axvline : vertical line across the Axes

Notes
-----


.. note::
    In addition to the above described arguments, this function can take
    a *data* keyword argument. If such a *data* argument is given,
    the following arguments can also be string ``s``, which is
    interpreted as ``data[s]`` (unless this raises an exception):
    *x*, *ymin*, *ymax*, *colors*.

    Objects passed as **data** must support item access (``data[s]``) and
    membership test (``s in data``).