W3cubDocs

matplotlib.axes.Axes.broken_barh

Axes.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

Other Parameters

dataindexable object, optional

If given, all parameters also accept a string s, which is interpreted as data[s] (unless this raises an exception).

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`	array-like or scalar or None
`animated`	bool
`antialiased` or aa or antialiaseds	bool or list of bools
`array`	array-like 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
`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_transform`	`Transform`
`offsets`	(N, 2) or (2,) array-like
`path_effects`	`AbstractPathEffect`
`paths`	list of array-like
`picker`	None or bool or float or callable
`pickradius`	float
`rasterized`	bool
`sizes`	ndarray or None
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool or None
`transform`	`Transform`
`url`	str
`urls`	list of str or None
`verts`	list of array-like
`verts_and_codes`	unknown
`visible`	bool
`zorder`	float