grafit-charts

---

Interface: FunnelSeriesOptions

Extends

• FunnelSeriesBaseOptions

Properties

calloutLine?

optional calloutLine?: Switchable & object

Line from a segment to its outside label (segment color by default).

Type Declaration

length?

optional length?: number

stroke?

optional stroke?: string

strokeWidth?

optional strokeWidth?: number

Inherited from

FunnelSeriesBaseOptions.calloutLine

---

fills?

optional fills?: string[]

Inherited from

FunnelSeriesBaseOptions.fills

---

id?

optional id?: string

Inherited from

FunnelSeriesBaseOptions.id

---

itemSpacing?

optional itemSpacing?: number

Gap between segments (4 by default).

Inherited from

FunnelSeriesBaseOptions.itemSpacing

---

label?

optional label?: Switchable & FontOptions & PartLabelBlockOptions<FunnelLabelFormatterParams> & object

Stage labels: the name and the value of a stage, drawn as one block so the two always read together — each half with its own font, layout putting the value in the same row (default) or on a line of its own. placement moves the whole block inside the segment (auto-contrast) or outside it, on a callout line to the right.

Type Declaration

formatter?

optional formatter?: (params) => string

The whole label at once; it wins over category/value.

Parameters

params

datum

Datum

stage

string

value

number

Returns

string

placement?

optional placement?: "outside" | "inside"

Inherited from

FunnelSeriesBaseOptions.label

---

name?

optional name?: string

Inherited from

FunnelSeriesBaseOptions.name

---

showInLegend?

optional showInLegend?: boolean

Inherited from

FunnelSeriesBaseOptions.showInLegend

---

stageField

stageField: string

Stage name.

Inherited from

FunnelSeriesBaseOptions.stageField

---

stageName?

optional stageName?: Formattable<PartNameParams>

How the value of stageField becomes text — for the legend, the tooltip heading and the name half of a stage label alike. A name is a field value, and the format of that field belongs to the series rather than to each place the name is printed in. label.category overrides it where a label wants something shorter than the legend.

Inherited from

FunnelSeriesBaseOptions.stageName

---

tooltip?

optional tooltip?: Switchable & object

Type Declaration

renderer?

optional renderer?: (params) => string | TooltipContentData

Parameters

params

FunnelTooltipRendererParams

Returns

string | TooltipContentData

Inherited from

FunnelSeriesBaseOptions.tooltip

---

type

type: "funnel"

---

valueField

valueField: string

Stage value.

Inherited from

FunnelSeriesBaseOptions.valueField

---

visible?

optional visible?: boolean

Inherited from

FunnelSeriesBaseOptions.visible

---

widthRatio?

optional widthRatio?: number

Fraction of the plot width used by the shape (0.62 by default); independent of labels.

Inherited from

FunnelSeriesBaseOptions.widthRatio