Module « matplotlib.pyplot »

Fonction broken_barh - module matplotlib.pyplot

Signature de la fonction broken_barh

def broken_barh(xranges, yrange, *, data=None, **kwargs) 

Description

broken_barh.__doc__

Plot a horizontal sequence of rectangles.

A rectangle is drawn for each element of *xranges*. All rectangles
have the same vertical position and size defined by *yrange*.

This is a convenience function for instantiating a
`.BrokenBarHCollection`, adding it to the Axes and autoscaling the
view.

Parameters
----------
xranges : sequence of tuples (*xmin*, *xwidth*)
    The x-positions and extends of the rectangles. For each tuple
    (*xmin*, *xwidth*) a rectangle is drawn from *xmin* to *xmin* +
    *xwidth*.
yrange : (*ymin*, *yheight*)
    The y-position and extend for all the rectangles.

Returns
-------
`~.collections.BrokenBarHCollection`

Other Parameters
----------------
**kwargs : `.BrokenBarHCollection` properties

    Each *kwarg* can be either a single argument applying to all
    rectangles, e.g.::

        facecolors='black'

    or a sequence of arguments over which is cycled, e.g.::

        facecolors=('black', 'blue')

    would create interleaving black and blue rectangles.

    Supported keywords:

    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
    alpha: array-like or scalar or None
    animated: bool
    antialiased or aa or antialiaseds: bool or list of bools
    array: ndarray or None
    capstyle: `.CapStyle` or {'butt', 'projecting', 'round'}
    clim: (vmin: float, vmax: float)
    clip_box: `.Bbox`
    clip_on: bool
    clip_path: Patch or (Path, Transform) or None
    cmap: `.Colormap` or str or None
    color: color or list of rgba tuples
    contains: unknown
    edgecolor or ec or edgecolors: color or list of colors or 'face'
    facecolor or facecolors or fc: color or list of colors
    figure: `.Figure`
    gid: str
    hatch: {'/', '\\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
    in_layout: bool
    joinstyle: `.JoinStyle` or {'miter', 'round', 'bevel'}
    label: object
    linestyle or dashes or linestyles or ls: str or tuple or list thereof
    linewidth or linewidths or lw: float or list of floats
    norm: `.Normalize` or None
    offset_position: unknown
    offsets: (N, 2) or (2,) array-like
    path_effects: `.AbstractPathEffect`
    picker: None or bool or float or callable
    pickradius: float
    rasterized: bool
    sketch_params: (scale: float, length: float, randomness: float)
    snap: bool or None
    transform: `.Transform`
    url: str
    urls: list of str or None
    visible: bool
    zorder: float

Notes
-----


.. note::
    In addition to the above described arguments, this function can take
    a *data* keyword argument. If such a *data* argument is given,
    every other argument can also be string ``s``, which is
    interpreted as ``data[s]`` (unless this raises an exception).

    Objects passed as **data** must support item access (``data[s]``) and
    membership test (``s in data``).