healpy.projaxes.SphericalProjAxes.axhline

SphericalProjAxes.axhline(y=0, xmin=0, xmax=1, **kwargs)

Add a horizontal line across the axis.

Call signature:

axhline(y=0, xmin=0, xmax=1, **kwargs)

Draw a horizontal line at y from xmin to xmax. With the default values of xmin = 0 and xmax = 1, this line will always span the horizontal extent of the axes, regardless of the xlim settings, even if you change them, e.g., with the set_xlim() command. That is, the horizontal extent is in axes coords: 0=left, 0.5=middle, 1.0=right but the y location is in data coordinates.

Return value is the Line2D instance. kwargs are the same as kwargs to plot, and can be used to control the line properties. e.g.,

  • 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 the middle half of the xrange:

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

Valid kwargs are Line2D properties, with the exception of ‘transform’:

agg_filter: unknown alpha: float (0.0 transparent through 1.0 opaque) animated: [True | False] antialiased or aa: [True | False] axes: an Axes instance clip_box: a matplotlib.transforms.Bbox instance clip_on: [True | False] clip_path: [ (Path, Transform) | Patch | None ] color or c: any matplotlib color contains: a callable function dash_capstyle: [‘butt’ | ‘round’ | ‘projecting’] dash_joinstyle: [‘miter’ | ‘round’ | ‘bevel’] dashes: sequence of on/off ink in points drawstyle: [‘default’ | ‘steps’ | ‘steps-pre’ | ‘steps-mid’ | ‘steps-post’] figure: a matplotlib.figure.Figure instance fillstyle: [‘full’ | ‘left’ | ‘right’ | ‘bottom’ | ‘top’ | ‘none’] gid: an id string label: string or anything printable with ‘%s’ conversion. linestyle or ls: ['-' | '--' | '-.' | ':' | 'None' | ' ' | ''] and any drawstyle in combination with a linestyle, e.g., 'steps--'. linewidth or lw: float value in points lod: [True | False] marker: unknown markeredgecolor or mec: any matplotlib color markeredgewidth or mew: float value in points markerfacecolor or mfc: any matplotlib color markerfacecoloralt or mfcalt: any matplotlib color markersize or ms: float markevery: None | integer | (startind, stride) path_effects: unknown picker: float distance in points or callable pick function fn(artist, event) pickradius: float distance in points rasterized: [True | False | None] sketch_params: unknown snap: unknown solid_capstyle: [‘butt’ | ‘round’ | ‘projecting’] solid_joinstyle: [‘miter’ | ‘round’ | ‘bevel’] transform: a matplotlib.transforms.Transform instance url: a url string visible: [True | False] xdata: 1D array ydata: 1D array zorder: any number

See also

axhspan()
for example plot and source code