matplotlib.axes.Axes.broken_barh

Axes.broken_barh(xranges, yrange, align='bottom', *, 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.

Note: Rectangles may become invisible if their width is smaller than the resolution of the display. If you expect very narrow rectangles, consider adding an edge with the same color as the facecolor by passing ``edgecolor="face"`. The edge will always be drawn, making narrow rectangles visible.

Parameters:

xrangessequence of tuples (xmin, xwidth)

The x-positions and extents of the rectangles. For each tuple (xmin, xwidth) a rectangle is drawn from xmin to xmin + xwidth.

yrange(ypos, yheight)

The y-position and extent for all the rectangles.

align{"bottom", "center", "top"}, default: 'bottom'

The alignment of the yrange with respect to the y-position. One of:

• "bottom": Resulting y-range [ypos, ypos + yheight]

• "center": Resulting y-range [ypos - yheight/2, ypos + yheight/2]

• "top": Resulting y-range [ypos - yheight, ypos]

Added in version 3.11.

Returns:

PolyCollection

Other Parameters:

dataindexable object, optional

If given, all parameters also accept a string s, which is interpreted as data[s] if s is a key in data.

**kwargsPolyCollection 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 and two offsets from the bottom left corner of the image
alpha	array-like or float or None
animated	bool
antialiased or aa or antialiaseds	bool or list of bools
array	array-like or None
blend_mode	blend mode
capstyle	CapStyle or {'butt', 'projecting', 'round'}
clim	(vmin: float, vmax: float)
clip_box	BboxBase or None
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 color or 'face'
facecolor or facecolors or fc	color or list of color
figure	Figure or SubFigure
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
hatch_linewidth	unknown
hatchcolor	color or list of color or 'edge'
in_layout	bool
joinstyle	JoinStyle or {'miter', 'round', 'bevel'}
label	object
linestyle or dashes or linestyles or ls	linestyle or list of linestyle
linewidth or linewidths or lw	float or list of floats
mouseover	bool
norm	Normalize or str or None
offset_transform or transOffset	Transform
offsets	(N, 2) or (2,) array-like
path_effects	list of AbstractPathEffect
paths	list of array-like
picker	None or bool or float or callable
pickradius	float
rasterized	bool
sizes	numpy.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

Examples using matplotlib.axes.Axes.broken_barh

Broken horizontal bars

Broken horizontal bars