matplotlib.pyplot.axline#
- matplotlib.pyplot.axline(xy1,xy2=None,*,slope=None,**kwargs)[source]#
Add an infinitely long straight line.
The line can be defined either by two pointsxy1 andxy2, orby one pointxy1 and aslope.
This draws a straight line "on the screen", regardless of the x and yscales, and is thus also suitable for drawing exponential decays insemilog plots, power laws in loglog plots, etc. However,slopeshould only be used with linear scales; It has no clear meaning forall other scales, and thus the behavior is undefined. Please specifythe line using the pointsxy1,xy2 for non-linear scales.
Thetransform keyword argument only applies to the pointsxy1,xy2. Theslope (if given) is always in data coordinates. This canbe used e.g. with
ax.transAxes
for drawing grid lines with a fixedslope.- Parameters:
- xy1, xy2(float, float)
Points for the line to pass through.Eitherxy2 orslope has to be given.
- slopefloat, optional
The slope of the line. Eitherxy2 orslope has to be given.
- Returns:
- Other Parameters:
- **kwargs
Valid kwargs are
Line2D
propertiesProperty
Description
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image
float or None
bool
bool
BboxBase
or Nonebool
Patch or (Path, Transform) or None
CapStyle
or {'butt', 'projecting', 'round'}JoinStyle
or {'miter', 'round', 'bevel'}sequence of floats (on/off ink in points) or (None, None)
(2, N) array or two 1D arrays
{'default', 'steps', 'steps-pre', 'steps-mid', 'steps-post'}, default: 'default'
{'full', 'left', 'right', 'bottom', 'top', 'none'}
color or None
str
bool
object
{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
float
marker style string,
Path
orMarkerStyle
float
markersize
orms
float
None or int or (int, int) or slice or list[int] or float or (float, float) or list[bool]
bool
list of
AbstractPathEffect
float or callable[[Artist, Event], tuple[bool, dict]]
float
bool
(scale: float, length: float, randomness: float)
bool or None
CapStyle
or {'butt', 'projecting', 'round'}JoinStyle
or {'miter', 'round', 'bevel'}unknown
str
bool
1D array
1D array
float
Notes
Note
This is thepyplot wrapper for
axes.Axes.axline
.Examples
Draw a thick red line passing through (0, 0) and (1, 1):
>>>axline((0,0),(1,1),linewidth=4,color='r')