On this page
matplotlib.axes.Axes.broken_barh
Axes.broken_barh(self, 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: -
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_filtera filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array alphafloat or None animatedbool antialiasedor aa or antialiasedsbool or sequence of bools arrayndarray capstyle{'butt', 'round', 'projecting'} clima length 2 sequence of floats; may be overridden in methods that have vminandvmaxkwargs.clip_boxBboxclip_onbool clip_path[( Path,Transform) |Patch| None]cmapcolormap or registered colormap name colorcolor or sequence of rgba tuples containscallable edgecoloror ec or edgecolorscolor or sequence of colors or 'face' facecoloror facecolors or fccolor or sequence of colors figureFiguregidstr hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'} in_layoutbool joinstyle{'miter', 'round', 'bevel'} labelobject linestyleor dashes or linestyles or ls{'-', '--', '-.', ':', '', (offset, on-off-seq), ...} linewidthor linewidths or lwfloat or sequence of floats normNormalizeoffset_position{'screen', 'data'} offsetsfloat or sequence of floats path_effectsAbstractPathEffectpickerNone or bool or float or callable pickradiusunknown rasterizedbool or None sketch_params(scale: float, length: float, randomness: float) snapbool or None transformTransformurlstr urlsList[str] or None visiblebool zorderfloat
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). -
© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.1.1/api/_as_gen/matplotlib.axes.Axes.broken_barh.html