Participer au site avec un Tip
Rechercher
 

Améliorations / Corrections

Vous avez des améliorations (ou des corrections) à proposer pour ce document : je vous remerçie par avance de m'en faire part, cela m'aide à améliorer le site.

Emplacement :

Description des améliorations :

Vous êtes un professionnel et vous avez besoin d'une formation ? Coder avec une
Intelligence Artificielle
Voir le programme détaillé
Module « matplotlib.pyplot »

Fonction axhline - module matplotlib.pyplot

Signature de la fonction axhline

def axhline(y: 'float' = 0, xmin: 'float' = 0, xmax: 'float' = 1, **kwargs) -> 'Line2D' 

Description

help(matplotlib.pyplot.axhline)

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

Note: If you want to set x-limits in data coordinates, use
`~.Axes.hlines` instead.

Parameters
----------
y : float, default: 0
    y position in :ref:`data coordinates <coordinate-systems>`.

xmin : float, default: 0
    The start x-position in :ref:`axes coordinates <coordinate-systems>`.
    Should be between 0 and 1, 0 being the far left of the plot,
    1 the far right of the plot.

xmax : float, default: 1
    The end x-position in :ref:`axes coordinates <coordinate-systems>`.
    Should be between 0 and 1, 0 being the far left of the plot,
    1 the far right of the plot.

Returns
-------
`~matplotlib.lines.Line2D`
    A `.Line2D` specified via two points ``(xmin, y)``, ``(xmax, y)``.
    Its transform is set such that *x* is in
    :ref:`axes coordinates <coordinate-systems>` and *y* is in
    :ref:`data coordinates <coordinate-systems>`.

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

Other Parameters
----------------
**kwargs
    Valid keyword arguments are `.Line2D` properties, except for
    'transform':

    Properties:
    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: scalar or None
    animated: bool
    antialiased or aa: bool
    clip_box: `~matplotlib.transforms.BboxBase` or None
    clip_on: bool
    clip_path: Patch or (Path, Transform) or None
    color or c: :mpltype:`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: `~matplotlib.figure.Figure` or `~matplotlib.figure.SubFigure`
    fillstyle: {'full', 'left', 'right', 'bottom', 'top', 'none'}
    gapcolor: :mpltype:`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.Path` or `~.markers.MarkerStyle`
    markeredgecolor or mec: :mpltype:`color`
    markeredgewidth or mew: float
    markerfacecolor or mfc: :mpltype:`color`
    markerfacecoloralt or mfcalt: :mpltype:`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
--------
hlines : Add horizontal lines in data coordinates.
axhspan : Add a horizontal span (rectangle) across the axis.
axline : Add a line with an arbitrary slope.

Notes
-----

.. note::

    This is the :ref:`pyplot wrapper <pyplot_interface>` 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 of
  the xrange::

    >>> axhline(y=.5, xmin=0.25, xmax=0.75)


Vous êtes un professionnel et vous avez besoin d'une formation ? Coder avec une
Intelligence Artificielle
Voir le programme détaillé