Interface: D3PFunnelProps ​

Defined in: core/renderers/funnel.ts:35

Props of a funnel: its style, its shape, the order of the stages, the gap between them, its width and its neck, the hover effect and the labels.

Properties ​

gap ​

ts
gap: number;

Defined in: core/renderers/funnel.ts:47

Gap between stages, in pixels.

hover ​

ts
hover: boolean;

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

Dim the other stages while one is hovered (asks for an interaction area).

labels ​

ts
labels: object;

Defined in: core/renderers/funnel.ts:55

auto writes inside a stage when the text fits, beside it otherwise.

color ​

ts
color: string;

enabled ​

ts
enabled: boolean;

format? ​

ts
format?: (stage) => string;
Parameters ​
stage ​

D3PFunnelStage

Returns ​

string

outsideColor ​

ts
outsideColor: string;

position ​

ts
position: "auto" | "inside" | "outside";

neck ​

ts
neck: number;

Defined in: core/renderers/funnel.ts:51

Width of the bottom of the last stage, as a fraction of its top (funnel shape).

shape ​

ts
shape: "funnel" | "bars";

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

funnel: each stage narrows to the next one. bars: centered rectangles.

sort ​

ts
sort: "none" | "descending";

Defined in: core/renderers/funnel.ts:45

descending puts the largest stage on top (default); none keeps the data order.

style ​

ts
style: D3PRendererStyleBase & object;

Defined in: core/renderers/funnel.ts:37

The style: the colors of the stages (by position, cycled), and the stroke between them.

Type Declaration ​

colors? ​
ts
colors?: string[];
stroke ​
ts
stroke: string;
strokeWidth ​
ts
strokeWidth: number;

width ​

ts
width: number;

Defined in: core/renderers/funnel.ts:49

Width of the widest stage, as a fraction of the chart (default 0.9).