Interface: D3PBarProps ​

Defined in: core/renderers/bar.ts:14

Props of bars: the style, how many series share a band (count, index), the orientation and the column the bars start from (base).

Properties ​

base? ​

ts
base?: string;

Defined in: core/renderers/bar.ts:53

Column holding the base of each bar: a range, a layer of a stack, a waterfall step. Default: the y0 column when the series has one, else the zero line.

count ​

ts
count: number;

Defined in: core/renderers/bar.ts:41

Number of bar series side by side (band axis).

index ​

ts
index: number;

Defined in: core/renderers/bar.ts:43

1-based index of this series among the grouped ones (band axis).

orientation ​

ts
orientation: "vertical" | "horizontal";

Defined in: core/renderers/bar.ts:48

vertical: the series' x is on the first dimension (columns; polar: a rose). horizontal: it is on the second one (bars; polar: radial bars) and the value on the first.

style ​

ts
style: D3PRendererStyleBase & object;

Defined in: core/renderers/bar.ts:18

The style: the color, the width of the bars, their offset in the band and the margin between them, and the shape (bar or lollipop).

Type Declaration ​

barWidth? ​
ts
barWidth?: number;

Width of a bar. Band axis: fraction of the band (default 0.9). Bins (x0/x1 columns): fraction of the bin (default 0.95). Otherwise in range units: pixels on a cartesian X axis, radians on a polar angle (default 20).

colorBy? ​
ts
colorBy?: string;

Column whose value picks the color in colors (a waterfall's kind).

colors? ​
ts
colors?: Record<string, string>;
headRadius ​
ts
headRadius: number;

Dot radius and stem width of a lollipop, in pixels.

margin ​
ts
margin: number;

Fraction of the bar slot left empty between grouped bars (band axis).

negativeColor? ​
ts
negativeColor?: string;

Color of the bars whose value is below their base.

offset ​
ts
offset: number;

Shift of the bar along the category axis (continuous: range units; band: fraction of the band).

shape ​
ts
shape: "bar" | "lollipop";

bar: a filled cell; lollipop: a stem with a dot at the end.

stemWidth ​
ts
stemWidth: number;