matplotlib.pyplot.axhline#
- matplotlib.pyplot.axhline(y=0,xmin=0,xmax=1,**kwargs)[source]#
Add a horizontal line spanning the whole or fraction of the Axes.
Note: If you want to set x-limits in data coordinates, use
hlines
instead.- Parameters:
- yfloat, default: 0
y position indata coordinates.
- xminfloat, default: 0
The start x-position inaxes coordinates.Should be between 0 and 1, 0 being the far left of the plot,1 the far right of the plot.
- xmaxfloat, default: 1
The end x-position inaxes coordinates.Should be between 0 and 1, 0 being the far left of the plot,1 the far right of the plot.
- Returns:
Line2D
A
Line2D
specified via two points(xmin,y)
,(xmax,y)
.Its transform is set such thatx is inaxes coordinates andy is indata coordinates.This is still a generic line and the horizontal character is onlyrealized through using identicaly values for both points. Thus,if you want to change they value later, you have to provide twovalues
line.set_ydata([3,3])
.
- Other Parameters:
- **kwargs
Valid keyword arguments are
Line2D
properties, except for'transform':Property
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
See also
Notes
Note
This is thepyplot wrapper for
axes.Axes.axhline
.Examples
draw a thick red hline at 'y' = 0 that spans the xrange:
>>>axhline(linewidth=4,color='r')
draw a default hline at 'y' = 1 that spans the xrange:
>>>axhline(y=1)
draw a default hline at 'y' = .5 that spans the middle half ofthe xrange:
>>>axhline(y=.5,xmin=0.25,xmax=0.75)