Skip to main content

Funnel

Ant Design

The Funnel chart shows how many items reach each stage of a process, such as visitors, signups and purchases, with each stage's share of the first stage.

Properties​

Property
Description
Expected Value
DataThe stages to show, in order from first to last, such as [{ stage, value }].Array
X fieldName of the field in Data that holds the stage name.Text. Default: stage
Y fieldName of the field that holds the stage's value.Array. Default: ["value"]
Color fieldThis chart colors each stage on its own, so this setting has no visible effect.Text
TitleHeading shown above the chart.Text
LegendThis chart shows no legend, so this setting has no visible effect.top, bottom, right, none. Default: top
LabelThis chart always labels each stage with its name, value and share of the first stage, so this setting has no visible effect.On or off. Default: Off
Y formatterHow values in labels and tooltips are written. compact shortens large numbers, such as 1.2K; percent reads 0.25 as 25%; auto shows whole numbers with no decimals and others with up to two.auto, number, currency, percent, compact. Default: compact
CurrencyCurrency code, such as USD or EUR, used when Y formatter is currency.Text. Default: USD
LocaleLocale for number and currency formats, such as pt-BR. Leave it empty to follow the currency's usual format.Text
Highlight clicked pointKeeps the clicked mark at full strength and fades the rest, until another mark is clicked or Clear clicked point runs.On or off. Default: Off

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On element clickTriggers when the user clicks a mark on the chart, such as a bar or point.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Clear clicked pointClears the clicked mark, which empties selectedDatum and removes the highlight.components.funnel1.clearClickedPoint()
Set visibilityShows the component when true, hides it when false.components.funnel1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.funnel1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.funnel1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
dataThe stages to show, in order from first to last, such as [{ stage, value }].{{components.funnel1.data}}
xFieldName of the field in Data that holds the stage name.{{components.funnel1.xField}}
yFieldName of the field that holds the stage's value.{{components.funnel1.yField}}
colorFieldThis chart colors each stage on its own, so this setting has no visible effect.{{components.funnel1.colorField}}
titleHeading shown above the chart.{{components.funnel1.title}}
legendThis chart shows no legend, so this setting has no visible effect.{{components.funnel1.legend}}
labelThis chart always labels each stage with its name, value and share of the first stage, so this setting has no visible effect.{{components.funnel1.label}}
yFormatterHow values in labels and tooltips are written. compact shortens large numbers, such as 1.2K; percent reads 0.25 as 25%; auto shows whole numbers with no decimals and others with up to two.{{components.funnel1.yFormatter}}
currencyCurrency code, such as USD or EUR, used when Y formatter is currency.{{components.funnel1.currency}}
localeLocale for number and currency formats, such as pt-BR. Leave it empty to follow the currency's usual format.{{components.funnel1.locale}}
highlightClickedKeeps the clicked mark at full strength and fades the rest, until another mark is clicked or Clear clicked point runs.{{components.funnel1.highlightClicked}}
selectedDatumThe data row of the mark the user clicked last. It is empty after Clear clicked point.{{components.funnel1.selectedDatum}}
isVisibleWhether the component is visible.{{components.funnel1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.funnel1.isLoading}}
isDisabledWhether the component is disabled.{{components.funnel1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.