arviz_plots.backend.hline

Contents

arviz_plots.backend.hline#

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

Interface to a horizontal reference line.

Parameters:
yfloat or array_like

Y position(s) where the horizontal 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:
hline_visualany

The backend object representing the horizontal line.