Skip to main content

hbar

lq.hbar(x, y, fill=auto, stroke=none, align=center, width=0.8, offset=0, base=0, label=none, clip=true, z-index=2)

Creates a horizontal bar plot from the given data.

#lq.diagram(
  yaxis: (subticks: none),
  lq.hbar(
    (1, 2, 3, 2, 5, 3),
    (1, 2, 3, 4, 5, 6),
  )
)

Also see bar.

Parameters

x : array​

An array of xx coordinates specifying the bar lengths.

y : array​

An array of yy coordinates specifying the bar positions. The number of xx and yy coordinates must match.

fill : none | color | gradient | tiling | array    default: auto​

How to fill the bars. This can be a single value applied to all bars or an array with the same length as the coordinate arrays.

stroke : auto | none | color | length | stroke | gradient | tiling | dictionary    default: none​

How to stroke the bars. All values allowed by the built-in rect function are also allowed here, see std.rect#stroke. In particular, note that by passing a dictionary, the individual sides of the bars can be stroked independently.

align : top | center | bottom    default: center​

Alignment of the bars at the yy values.

Details

Demonstration of the different alignment modes.

#lq.diagram(
  yaxis: (subticks: none),
  lq.hbar(
    (1,2,3,4,5), (1,2,3,4,5),
    width: 0.2, fill: red,
    align: top, label: "top"
  ),
  lq.hbar(
    (5,4,3,2,1), (1,2,3,4,5),
    width: 0.2, fill: blue,
    align: bottom, label: "bottom"
  ),
  lq.hbar(
    (2.5,) * 5, (1,2,3,4,5),
    width: 0.2, fill: rgb("#AAEEAA99"),
    align: center, label: "center"
  ),
)

width : int | float | array    default: 0.8​

Width of the bars in data coordinates. The width can be set either to a constant for all bars or per-bar by passing an array with the same length as the coordinate arrays.

Details

Example for a bar plot with varying bar widths.

#lq.diagram(
  lq.hbar(
    (1, 2, 3, 2, 5),
    (1, 2, 3, 4, 5),
    width: (1, 0.5, 1, 0.5, 1),
    fill: orange,
  )
)

offset : int | float    default: 0​

An offset to apply to all yy coordinates. This is equivalent to replacing the array passed to bar.y with y.map(y => y + offset). Using an offset can be useful to avoid overlaps when plotting multiple bar plots into one diagram.

base : int | float | array    default: 0​

Defines the xx coordinate of the baseline of the bars. This can either be a constant value applied to all bars or it can be set per-bar by passing an array with the same length as the coordinate arrays.

Details

Bar plot with varying base.

#lq.diagram(
  yaxis: (subticks: none),
  lq.hbar(
    (1, 2, 3, 0, 5),
    (1, 2, 3, 4, 5),
    base: (0, 1, 2, -1, 0),
    fill: white,
    stroke: 0.7pt
  )
)

label : content    default: none​

The legend label for this plot. See plot.label.

clip : bool    default: true​

Whether to clip the plot to the data area. See plot.clip.

z-index : int | float    default: 2​

Determines the zz position of this plot in the order of rendered diagram objects. See plot.z-index.