matplotlib.axes.Axes.axline — Matplotlib 3.10.3 documentation (original) (raw)

Axes.axline(xy1, xy2=None, *, slope=None, **kwargs)[source]#

Add an infinitely long straight line.

The line can be defined either by two points xy1 and xy2, or by one point xy1 and a slope.

This draws a straight line "on the screen", regardless of the x and y scales, and is thus also suitable for drawing exponential decays in semilog plots, power laws in loglog plots, etc. However, _slope_should only be used with linear scales; It has no clear meaning for all other scales, and thus the behavior is undefined. Please specify the line using the points xy1, xy2 for non-linear scales.

The transform keyword argument only applies to the points xy1,xy2. The slope (if given) is always in data coordinates. This can be used e.g. with ax.transAxes for drawing grid lines with a fixed slope.

Parameters:

xy1, xy2(float, float)

Points for the line to pass through. Either xy2 or slope has to be given.

slopefloat, optional

The slope of the line. Either xy2 or slope has to be given.

Returns:

AxLine

Other Parameters:

**kwargs

Valid kwargs are Line2D properties

Examples

Draw a thick red line passing through (0, 0) and (1, 1):

axline((0, 0), (1, 1), linewidth=4, color='r')

Examples using matplotlib.axes.Axes.axline#