matplotlib.pyplot.broken_barh

matplotlib.pyplot.broken_barh(xranges, yrange, *, data=None, **kwargs) [source]

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:

xrangessequence 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:

collectionA BrokenBarHCollection

Other Parameters:

**kwargsBrokenBarHCollection 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:

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
`alpha`	float or None
`animated`	bool
`antialiased` or aa or antialiaseds	bool or sequence of bools
`array`	ndarray
`capstyle`	{'butt', 'round', 'projecting'}
`clim`	(vmin: float, vmax: float)
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Patch or (Path, Transform) or None
`cmap`	colormap or registered colormap name
`color`	color or sequence of rgba tuples
`contains`	callable
`edgecolor` or ec or edgecolors	color or sequence of colors or 'face'
`facecolor` or facecolors or fc	color or sequence of colors
`figure`	`Figure`
`gid`	str
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bool
`joinstyle`	{'miter', 'round', 'bevel'}
`label`	object
`linestyle` or dashes or linestyles or ls	{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
`linewidth` or linewidths or lw	float or sequence of floats
`norm`	`Normalize`
`offset_position`	{'screen', 'data'}
`offsets`	array-like (N, 2) or (2,)
`path_effects`	`AbstractPathEffect`
`picker`	None or bool or float or callable
`pickradius`	unknown
`rasterized`	bool or None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool or None
`transform`	`Transform`
`url`	str
`urls`	List[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, the following arguments are replaced by data[<arg>]:

All positional and all keyword arguments.

Objects passed as data must support item access (data[<arg>]) and membership test (<arg> in data).