arviz_plots.backend.vline

Contents

arviz_plots.backend.vline#

arviz_plots.backend.vline(x, target, *, color=<unset>, alpha=<unset>, width=<unset>, linestyle=<unset>, **artist_kws)[source]#

Interface to a vertical reference line.

Parameters:
xfloat or array_like

X position(s) where the vertical line(s) should be drawn.

targetPlotObject

The backend object representing a plot where this visual should be added.

color, alpha, width, linestyleany, optional

Properties of the generated visual. If needed, see Keyword arguments for more details.

**artist_kws

Passed to the backend plotting function of the respective backend.

Returns:
vline_visualany

The backend object representing the vertical line.