matplotlib.pyplot.broken_barh

matplotlib.pyplot.broken_barh(xranges, yrange, hold=None, 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:

matplotlib.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:

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 antialiaseds	Boolean or sequence of booleans
array	ndarray
capstyle	unknown
clim	a length 2 sequence of floats
clip_box	a Bbox instance
clip_on	bool
clip_path	[(Path, Transform) | Patch | None]
cmap	a colormap or registered colormap name
color	matplotlib color arg or sequence of rgba tuples
contains	a callable function
edgecolor or edgecolors	matplotlib color spec or sequence of specs
facecolor or facecolors	matplotlib color spec or sequence of specs
figure	a Figure instance
gid	an id string
hatch	[ ‘/’ | ‘' | ‘|’ | ‘-‘ | ‘+’ | ‘x’ | ‘o’ | ‘O’ | ‘.’ | ‘*’ ]
joinstyle	unknown
label	object
linestyle or dashes or linestyles	[‘solid’ | ‘dashed’, ‘dashdot’, ‘dotted’ | (offset, on-off-dash-seq) | '-' | '--' | '-.' | ':' | 'None' | ' ' | '']
linewidth or linewidths or lw	float or sequence of floats
norm	Normalize
offset_position	[ ‘screen’ | ‘data’ ]
offsets	float or sequence of floats
path_effects	AbstractPathEffect
picker	[None | bool | float | callable]
pickradius	float distance in points
rasterized	bool or None
sketch_params	(scale: float, length: float, randomness: float)
snap	bool or None
transform	Transform
url	a url string
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.