matplotlib.pyplot.axvline#

matplotlib.pyplot.axvline(x=0,ymin=0,ymax=1,**kwargs)[source]#

Add a vertical line spanning the whole or fraction of the Axes.

Note: If you want to set y-limits in data coordinates, usevlines instead.

Parameters:
xfloat, default: 0

x position indata coordinates.

yminfloat, default: 0

The start y-position inaxes coordinates.Should be between 0 and 1, 0 being the bottom of the plot, 1 thetop of the plot.

ymaxfloat, default: 1

The end y-position inaxes coordinates.Should be between 0 and 1, 0 being the bottom of the plot, 1 thetop of the plot.

Returns:
Line2D

ALine2D specified via two points(x,ymin),(x,ymax).Its transform is set such thatx is indata coordinates andy is inaxes coordinates.

This is still a generic line and the vertical character is onlyrealized through using identicalx values for both points. Thus,if you want to change thex value later, you have to provide twovaluesline.set_xdata([3,3]).

Other Parameters:
**kwargs

Valid keyword arguments areLine2D properties, except for'transform':

Property

Description

agg_filter

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

alpha

float or None

animated

bool

antialiased oraa

bool

clip_box

BboxBase or None

clip_on

bool

clip_path

Patch or (Path, Transform) or None

color orc

color

dash_capstyle

CapStyle or {'butt', 'projecting', 'round'}

dash_joinstyle

JoinStyle or {'miter', 'round', 'bevel'}

dashes

sequence of floats (on/off ink in points) or (None, None)

data

(2, N) array or two 1D arrays

drawstyle ords

{'default', 'steps', 'steps-pre', 'steps-mid', 'steps-post'}, default: 'default'

figure

Figure orSubFigure

fillstyle

{'full', 'left', 'right', 'bottom', 'top', 'none'}

gapcolor

color or None

gid

str

in_layout

bool

label

object

linestyle orls

{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}

linewidth orlw

float

marker

marker style string,Path orMarkerStyle

markeredgecolor ormec

color

markeredgewidth ormew

float

markerfacecolor ormfc

color

markerfacecoloralt ormfcalt

color

markersize orms

float

markevery

None or int or (int, int) or slice or list[int] or float or (float, float) or list[bool]

mouseover

bool

path_effects

list ofAbstractPathEffect

picker

float or callable[[Artist, Event], tuple[bool, dict]]

pickradius

float

rasterized

bool

sketch_params

(scale: float, length: float, randomness: float)

snap

bool or None

solid_capstyle

CapStyle or {'butt', 'projecting', 'round'}

solid_joinstyle

JoinStyle or {'miter', 'round', 'bevel'}

transform

unknown

url

str

visible

bool

xdata

1D array

ydata

1D array

zorder

float

See also

vlines

Add vertical lines in data coordinates.

axvspan

Add a vertical span (rectangle) across the axis.

axline

Add a line with an arbitrary slope.

Notes

Examples

  • draw a thick red vline atx = 0 that spans the yrange:

    >>>axvline(linewidth=4,color='r')
  • draw a default vline atx = 1 that spans the yrange:

    >>>axvline(x=1)
  • draw a default vline atx = .5 that spans the middle half ofthe yrange:

    >>>axvline(x=.5,ymin=0.25,ymax=0.75)

Examples usingmatplotlib.pyplot.axvline#

Infinite lines

Infinite lines