matplotlib.axes.Axes.axvline#

Axes.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, use vlines instead.

Parameters:
xfloat, default: 0

x position in data coordinates.

yminfloat, default: 0

The start y-position in axes coordinates. Should be between 0 and 1, 0 being the bottom of the plot, 1 the top of the plot.

ymaxfloat, default: 1

The end y-position in axes coordinates. Should be between 0 and 1, 0 being the bottom of the plot, 1 the top of the plot.

Returns:
Line2D

A Line2D specified via two points (x, ymin), (x, ymax). Its transform is set such that x is in data coordinates and y is in axes coordinates.

This is still a generic line and the vertical character is only realized through using identical x values for both points. Thus, if you want to change the x value later, you have to provide two values line.set_xdata([3, 3]).

Other Parameters:
**kwargs

Valid keyword arguments are Line2D 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 or aa

bool

clip_box

BboxBase or None

clip_on

bool

clip_path

Patch or (Path, Transform) or None

color or c

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 or ds

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

figure

Figure or SubFigure

fillstyle

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

gapcolor

color or None

gid

str

in_layout

bool

label

object

linestyle or ls

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

linewidth or lw

float

marker

marker style string, Path or MarkerStyle

markeredgecolor or mec

color

markeredgewidth or mew

float

markerfacecolor or mfc

color

markerfacecoloralt or mfcalt

color

markersize or ms

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 of AbstractPathEffect

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.

Examples

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

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

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

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

Examples using matplotlib.axes.Axes.axvline#

Cross-hair cursor

Cross-hair cursor

Infinite lines

Infinite lines

SkewT-logP diagram: using transforms and custom projections

SkewT-logP diagram: using transforms and custom projections

Plot a confidence ellipse of a two-dimensional dataset

Plot a confidence ellipse of a two-dimensional dataset

Draw regions that span an Axes

Draw regions that span an Axes

Secondary Axis

Secondary Axis

Usetex text baseline

Usetex text baseline

The Lifecycle of a Plot

The Lifecycle of a Plot

Annotations

Annotations