WrightTools.artists.diagonal_line

WrightTools.artists.diagonal_line(xi=None, yi=None, *, ax=None, c=None, ls=None, lw=None, zorder=3)[source]

Plot a diagonal line.

Parameters:

  • xi (1D array-like (optional)) – The x axis points. If None, taken from axis limits. Default is None.

  • yi (1D array-like) – The y axis points. If None, taken from axis limits. Default is None.

  • ax (axis (optional)) – Axis to plot on. If none is supplied, the current axis is used.

  • c (string (optional)) – Line color. Default derives from rcParams grid color.

  • ls (string (optional)) – Line style. Default derives from rcParams linestyle.

  • lw (float (optional)) – Line width. Default derives from rcParams linewidth.

  • zorder (number (optional)) – Matplotlib zorder. Default is 3.

Returns:

The plotted line.

Return type:

matplotlib.lines.Line2D object