Skip to main content

Funnel Chart

Rocket 2.0

The Funnel Chart component shows how a count drops from one stage to the next, such as visitors to sign-ups to paying customers. Each stage is a bar sized against the largest stage, with its value and conversion rate.

Properties​

Property
Description
Expected Value
DataList of rows to chart, one per stage, in the order the stages run. Up to 24 stages are drawn.Array
Stage fieldKey in each row that holds the stage name.Text. Default: stage
Value fieldKey in each row that holds the stage's count.Text. Default: count
Conversion %Shows each stage's conversion rate as a percentage next to its value.On or off. Default: On
Conversion fromWhat each stage's conversion rate compares against: the Previous stage or the First stage.Previous stage, First stage. Default: Previous stage
Bar alignmentWhether bars are centered, for a funnel shape, or aligned to the left.center, left. Default: center
Colour per stageGives each stage its own color from Series colors (in order). When off, all stages share one color that fades down the funnel.On or off. Default: Off
Value formatHow values are written: number, currency, percent or compact (like 12.5K). With percent, fractions such as 0.25 read as 25%.number, currency, percent, compact. Default: number
Currency codeCurrency code used when Value format is currency, such as USD or EUR.Text. Default: USD
LocaleNumber and currency format, such as pt-BR. Leave it empty to follow the currency.Text
Value prefixText added before each value.Text
Value suffixText added after each value.Text
Empty messageMessage shown when there is no data to chart.Text. Default: No data
AnimateGrows the bars in when the chart first draws.On or off. Default: On
Series colors (in order)Colors for the bars, in order. Leave it empty to use Chart color.Array
Highlight clicked pointEmphasizes the clicked stage until another is clicked or Clear clicked point runs.On or off. Default: Off
Loading lookWhat the component shows while it is loading: a Spinner or a grey Skeleton placeholder.Spinner, Skeleton. Default: Spinner

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 clickTriggers when the user clicks a stage.
On double clickTriggers when the user double-clicks the chart.

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 stage and removes its highlight.components.funnelchart1.clearClickedPoint()
Set visibilityShows the component when true, hides it when false.components.funnelchart1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.funnelchart1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.funnelchart1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
dataList of rows to chart, one per stage, in the order the stages run. Up to 24 stages are drawn.{{components.funnelchart1.data}}
stageFieldKey in each row that holds the stage name.{{components.funnelchart1.stageField}}
valueFieldKey in each row that holds the stage's count.{{components.funnelchart1.valueField}}
showConversionShows each stage's conversion rate as a percentage next to its value.{{components.funnelchart1.showConversion}}
conversionBaseWhat each stage's conversion rate compares against: the Previous stage or the First stage.{{components.funnelchart1.conversionBase}}
alignWhether bars are centered, for a funnel shape, or aligned to the left.{{components.funnelchart1.align}}
colorByStageGives each stage its own color from Series colors (in order). When off, all stages share one color that fades down the funnel.{{components.funnelchart1.colorByStage}}
yAxisFormatHow values are written: number, currency, percent or compact (like 12.5K). With percent, fractions such as 0.25 read as 25%.{{components.funnelchart1.yAxisFormat}}
currencyCurrency code used when Value format is currency, such as USD or EUR.{{components.funnelchart1.currency}}
localeNumber and currency format, such as pt-BR. Leave it empty to follow the currency.{{components.funnelchart1.locale}}
valuePrefixText added before each value.{{components.funnelchart1.valuePrefix}}
valueSuffixText added after each value.{{components.funnelchart1.valueSuffix}}
emptyTextMessage shown when there is no data to chart.{{components.funnelchart1.emptyText}}
animateGrows the bars in when the chart first draws.{{components.funnelchart1.animate}}
colorsColors for the bars, in order. Leave it empty to use Chart color.{{components.funnelchart1.colors}}
highlightClickedEmphasizes the clicked stage until another is clicked or Clear clicked point runs.{{components.funnelchart1.highlightClicked}}
loadingIndicatorWhat the component shows while it is loading: a Spinner or a grey Skeleton placeholder.{{components.funnelchart1.loadingIndicator}}
clickedDataPointThe data row of the last stage the user clicked.{{components.funnelchart1.clickedDataPoint}}
isVisibleWhether the component is visible.{{components.funnelchart1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.funnelchart1.isLoading}}
isDisabledWhether the component is disabled.{{components.funnelchart1.isDisabled}}

Styles​

Style
Default
Chart color (series palette from it)Theme: Brand primary
Stage label colorTheme: Placeholder text
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.