matplotlib.pyplot.barh — Matplotlib 3.1.2 documentation (original) (raw)
matplotlib.pyplot. barh(y, width, height=0.8, left=None, *, align='center', **kwargs)[source]¶
Make a horizontal bar plot.
The bars are positioned at y with the given _align_ment. Their dimensions are given by width and height. The horizontal baseline is left (default 0).
Each of y, width, height, and left may either be a scalar applying to all bars, or it may be a sequence of length N providing a separate value for each bar.
| Parameters: | y : scalar or array-like The y coordinates of the bars. See also align for the alignment of the bars to the coordinates. width : scalar or array-like The width(s) of the bars. height : sequence of scalars, optional, default: 0.8 The heights of the bars. left : sequence of scalars The x coordinates of the left sides of the bars (default: 0). align : {'center', 'edge'}, optional, default: 'center' Alignment of the base to the y coordinates*: 'center': Center the bars on the y positions. 'edge': Align the bottom edges of the bars with the _y_positions. To align the bars on the top edge pass a negative height andalign='edge'. |
|---|---|
| Returns: | container : BarContainer Container with all the bars and optionally errorbars. |
| Other Parameters: | color : scalar or array-like, optional The colors of the bar faces. edgecolor : scalar or array-like, optional The colors of the bar edges. linewidth : scalar or array-like, optional Width of the bar edge(s). If 0, don't draw edges. tick_label : string or array-like, optional The tick labels of the bars. Default: None (Use default numeric labels.) xerr, yerr : scalar or array-like of shape(N,) or shape(2,N), optional If not None, add horizontal / vertical errorbars to the bar tips. The values are +/- sizes relative to the data: scalar: symmetric +/- values for all bars shape(N,): symmetric +/- values for each bar shape(2,N): Separate - and + values for each bar. First row contains the lower errors, the second row contains the upper errors. None: No errorbar. (default) See Different ways of specifying error barsfor an example on the usage of xerr and yerr. ecolor : scalar or array-like, optional, default: 'black' The line color of the errorbars. capsize : scalar, optional The length of the error bar caps in points. Default: None, which will take the value fromrcParams["errorbar.capsize"] = 0.0. error_kw : dict, optional Dictionary of kwargs to be passed to the errorbarmethod. Values of ecolor or capsize defined here take precedence over the independent kwargs. log : bool, optional, default: False If True, set the x-axis to be log scale. |
See also
Plot a vertical bar plot.
Notes
The optional arguments color, edgecolor, linewidth,xerr, and yerr can be either scalars or sequences of length equal to the number of bars. This enables you to use bar as the basis for stacked bar charts, or candlestick plots. Detail: xerr and yerr are passed directly toerrorbar(), so they can also have shape 2xN for independent specification of lower and upper errors.
Other optional kwargs:
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 aa unknown capstyle {'butt', 'round', 'projecting'} clip_box Bbox clip_on bool clip_path [(Path, Transform) | Patch None] color color contains callable edgecolor or ec color or None or 'auto' facecolor or fc color or None figure Figure fill bool gid str hatch {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'} in_layout bool joinstyle {'miter', 'round', 'bevel'} label object linestyle or ls {'-', '--', '-.', ':', '', (offset, on-off-seq), ...} linewidth or lw float or None path_effects AbstractPathEffect picker None or bool or float or callable rasterized bool or None sketch_params (scale: float, length: float, randomness: float) snap bool or None transform Transform url str visible bool zorder float