matplotlib.pyplot.broken_barh

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

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.

yranges : (ymin, ymax)

The y-position and extend for all the rectangles.

Returns:

collection : A 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:

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	bool or sequence of bools
array	ndarray
capstyle	{'butt', 'round', 'projecting'}
clim	a length 2 sequence of floats; may be overridden in methods that have vmin and vmax kwargs.
clip_box	Bbox
clip_on	bool
clip_path	[(Path, Transform) | Patch | None]
cmap	colormap or registered colormap name
color	matplotlib color arg or sequence of rgba tuples
contains	callable
edgecolor	color or sequence of colors
facecolor	color or sequence of colors
figure	Figure
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout	bool
joinstyle	{'miter', 'round', 'bevel'}
label	object
linestyle	{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth	float or sequence of floats
norm	Normalize
offset_position	{'screen', 'data'}
offsets	float or sequence of floats
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).