API / Series/Funnel / FunnelSeries

Defined in: src/core/types/chart/funnel.ts:33

Extends

Type Parameters

Type Parameter Default type
T MeaningfulAny

Properties

Property Type Description
color? string The color of the funnel series.
connectors? object Lines or areas connecting the funnel segments.
connectors.areaColor? string Connector area color.
connectors.areaOpacity? number Opacity for the connector area fill. Defaults to 0 for 'trapezoid', 0.25 for 'rectangle'.
connectors.enabled? boolean -
connectors.height? string | number The height of the connector area between funnel segments. Accepts a pixel number, a pixel string (e.g. '10px'), or a percentage string (e.g. '25%') relative to the segment band height. Defaults to 0 for 'trapezoid' and '25%' for 'rectangle'.
connectors.lineColor? string Connector line color.
connectors.lineDashStyle? "Dash" | "DashDot" | "Dot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "ShortDash" | "ShortDashDot" | "ShortDashDotDot" | "ShortDot" | "Solid" Option for line stroke style
connectors.lineOpacity? number Opacity for the connector line. Defaults to 0 for 'trapezoid', 1 for 'rectangle'.
connectors.lineWidth? number Connector line width in pixels.
cursor? string You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
custom? any A reserved subspace to store options and values for customized functionality Here you can add additional data for your own event callbacks and formatter callbacks
data FunnelSeriesData<T>[] -
dataLabels? Omit<BaseDataLabels, "allowOverlap"> & object -
legend? ChartLegendItem & object Individual series legend options. Has higher priority than legend options in widget data
name? string The name of the funnel series.
shape? "rectangle" | "trapezoid" The visual shape of funnel segments. - 'rectangle' (recommended): each segment is an independent rectangle whose width is directly proportional to its value. The human eye reads width as a linear scale, making comparisons between segments accurate and effortless. - 'trapezoid': adjacent segments are drawn as connected trapezoids, giving the chart a classic "funnel" silhouette. However, this shape distorts perception: the slanted sides cause viewers to judge area (which grows as the square of width) rather than width alone, exaggerating differences between large and small values. Use only for decorative purposes or when visual familiarity with the funnel metaphor is more important than analytical precision. Default 'rectangle'
tooltip? object Options for the tooltip that appears when the user hovers over a series or point.
tooltip.enabled? boolean Enable or disable the visibility of this series in the tooltip. Default true
tooltip.valueFormat? ValueFormat Formatting settings for tooltip value.
type "funnel" -
visible? boolean Initial visibility of the series
Previous
Overview
Next
FunnelSeriesData