The Funnel Chart component for classic apps

A content area to display funnel charts.

Classic apps

You're viewing documentation for classic apps, which use Retool's original app editor. The new app builder is the recommended way to build apps and where Retool focuses new development.

The Funnel Chart component renders data in a funnel shape, with sections of decreasing size. Funnel Chart is useful for visualizing data in different stages of a process.

Demo

Best practice

For more information about using the Funnel Chart component, refer to the charts guide.

Properties

All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

chartType

The type of chart to display.

Type	string
Format	Plain Text
Configurability	Inspector > Content > Series > Chart type
Allowed Values	Value UI Option Description bar Bar Bar Chart or Stacked Bar Chart. bubble Bubble Bubble Chart. funnel Funnel Funnel Chart. heatmap Heatmap Heat Map. line Line Line Chart or Sparkline. mixed Mixed Mixed Chart. pie Pie Pie Chart. plotlyJson Plotly JSON Plotly JSON Chart. sankey Sankey Sankey Chart. scatter Scatter Scatter Chart. sunburst Sunburst Sunburst Chart. treemap Treemap Treemap. waterfall Waterfall Waterfall Chart.
Default	funnel

Examples

false"bar"

---

clearOnEmptyData

Whether to clear the chart when the data is empty.

Type	boolean
Format	True/False
Configurability	Inspector > Content > Clear when data is empty
Default	false

Examples

falsetrue

---

colorArray

A list of colors to use when colorInputMode is colorArray.

Type	array
Format	Color
Array values	string
Configurability	Inspector
Default	null

Examples

false["#ff0000", "#00ff00", "#0000ff"]

---

colorArrayDropDown

A list of colors to use when colorInputMode is colorArrayDropDown.

Type	array
Format	Color
Array values	string
Configurability	Inspector > Appearance > Color selection
Default	null

Examples

false["#ff0000", "#00ff00", "#0000ff"]

---

colorInputMode

The mode for the color input.

Type	string
Format	Plain Text
Configurability	Inspector > Appearance > Color selection
Allowed Values	Value UI Option Description colorArray Array Color array. gradientColorArray Palette Gradient color array. colorArrayDropDown Manual Color array dropdown.
Default	colorArray

Examples

false"colorArray"

---

events

A list of configured event handlers that trigger actions or queries.

Type	array
Array values	object
Configurability	Inspector > Interaction > Event handlers
Default	null

Array Object Properties

event

The event that triggers the action. Refer to the events section for details of available events for this object.

Type	string
Configurability	Inspector > Interaction > Event handlers > Event
Default	null

---

method

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Run script actions
Default	null

---

type

The type of action to perform.

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Action
Allowed Values	Value Description datasource Control query. widget Control component. script Run script. state Set variable. localStorage Set localStorage. util Perform utility action (e.g., Open URL or Confetti).
Default	null

---

---

gradientColorArray

A list of colors to use when colorInputMode is gradientColorArray.

Type	array
Format	Color
Array values	string
Configurability	Inspector > Appearance > Color selection
Default	null

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Hidden
Default	false

Examples

falsetrue

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Configurability	Inspector
Default	funnelChart1

Examples

falsequery1

falsebutton1

---

isHiddenOnDesktop

Whether to show or hide this object in the desktop layout.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on desktop
Default	false

Examples

falsetrue

---

isHiddenOnMobile

Whether to show or hide this object in the mobile layout.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on mobile
Default	true

Examples

falsetrue

---

legendPosition

The position of the legend.

Type	string
Configurability	Inspector > Content > Add-ons > Legend position
Allowed Values	Value UI Option Description top Align top Top. right Align right Right. bottom Align bottom Bottom. left Align left Left. none No legend None.
Default	null

---

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

falsetrue

---

margin

The amount of margin to render outside.

Type	string
Format	Plain Text
Configurability	Inspector > Spacing > Margin
Allowed Values	Value UI Option Description 4px 8px Normal Normal margin. 0 None No margin.
Default	4px 8px

Examples

false4px 8px

---

paperBgColor

The paper background color.

Type	string
Configurability	Read-only
Default	null

---

plotBgColor

The plot background color.

Type	string
Configurability	Read-only
Default	null

---

selectedPoints

A list of selected points.

Type	array
Array values	object
Configurability	Read-only
Default	null

---

series

The chart series data.

Type	object
Configurability	Inspector
Default	null

Object Properties

yAxis

The y-axis configuration.

Type	object
Configurability	Inspector
Default	null

Object Properties

lineWidth

The width of the line.

Type	number
Configurability	Read-only
Default	null

---

rangeMax

The maximum value of the axis.

Type	number
Configurability	Inspector
Default	null

---

rangeMin

The minimum value of the axis.

Type	number
Configurability	Inspector
Default	null

---

rangeMode

The range mode of the axis.

Type	string
Configurability	Inspector
Allowed Values	Value Description auto Auto. manual Manual.
Default	null

---

scale

The scale of the axis.

Type	string
Configurability	Inspector
Allowed Values	Value Description linear Linear. log Logarithmic. time
Default	null

---

showGridLines

Whether to show grid lines on the axis.

Type	boolean
Configurability	Inspector
Default	null

---

showLine

Whether to show the axis line.

Type	boolean
Configurability	Inspector
Default	null

---

showTickLabels

Whether to show tick labels on the x-axis.

Type	boolean
Configurability	Inspector
Default	null

---

showZeroLine

Whether to show the zero line on the x-axis.

Type	boolean
Configurability	Inspector
Default	null

---

sort

The sorting of the axis.

Type	string
Configurability	Inspector
Allowed Values	Value Description none None. ascending Ascending. descending Descending.
Default	null

---

tickFormat

The format of the axis tick labels.

Type	string
Configurability	Inspector
Default	null

---

title

The axis title.

Type	string
Configurability	Inspector
Default	null

---

---

aggregationType

The type of aggregation to use.

Type	string
Format	Plain Text
Configurability	Inspector
Allowed Values	Value Description none None. sum Sum. average Average. count Count. countDistinct Count of distinct values. max Maximum. min Minimum. median Median. mode Mode. standardDeviation Standard deviation. first First Value. last Last Value.
Default	none

Examples

false"sum"

---

dataLabelPosition

The position of the label relative to the input field or value.

Type	string
Format	Plain Text
Configurability	Inspector > Content > Add-ons > Label > Position
Allowed Values	Value UI Option Description top Top Above the input field or value. left Left Left of the input field or value.
Default	left

Examples

falsetop

---

dataLabelTemplate

The template for the data label.

Type	string
Configurability	Inspector
Default	null

---

datasource

The source data when using UI Form.

Type	array
Array values	object
Configurability	Inspector
Default	null

---

groupBy

The column to group by.

Type	array
Configurability	Inspector
Default	null

---

groupByStyles

The styles of grouped data.

Type	string
Configurability	Read-only
Default	null

---

hoverTemplate

The tooltip template for displaying information when you hover over a point.

Type	string
Format	Plain Text
Configurability	Inspector > Content > Add-ons > Tooltip
Default	%{value}<br>%{percent}<extra></extra>

Examples

false%{value}<br>%{percent}<extra></extra>

---

lineColor

The color of the line.

Type	string
Format	Color
Configurability	Inspector > Content > Series > Appearance > Line color
Default	#000000

Examples

false#000000

false#FFFFFF

---

lineDash

The style of the line.

Type	string
Configurability	Inspector
Allowed Values	Value Description solid Solid. dash Dashed. dot Dotted.
Default	null

---

lineShape

The shape of the line.

Type	string
Configurability	Inspector
Allowed Values	Value Description linear Linear. spline Spline. hv Horizontal-Vertical. vh Vertical-Horizontal. hvh Horizontal-Vertical-Horizontal. vhv Vertical-Horizontal-Vertical.
Default	null

---

lineWidth

The width of the line.

Type	number
Configurability	Read-only
Default	null

---

markerBorderColor

The border color of the marker.

Type	string
Configurability	Inspector
Default	null

---

markerBorderWidth

The border width of the marker.

Type	number
Configurability	Inspector
Default	null

---

markerColor

The color of the marker.

Type	string
Configurability	Inspector
Default	null

---

markerSymbol

The type of marker.

Type	string
Configurability	Inspector
Allowed Values	Value Description circle Circle. square Square. diamond Diamond.
Default	null

---

name

The name.

Type	string
Configurability	Read-only
Default	null

---

showMarkers

Whether to show markers for data points.

Type	boolean
Configurability	Inspector
Default	null

---

type

The type of series to display.

Type	string
Configurability	Inspector
Allowed Values	Value Description line Line. bar Bar. scatter Scatter. waterfall Waterfall.
Default	null

---

xData

The x-axis data.

Type	array
Array values	object
Configurability	Read-only
Default	null

---

yData

The y-axis data.

Type	array
Configurability	Read-only
Default	null

---

---

showInEditor

Whether the component remains visible in the editor if hidden is true.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

falsetrue

---

toolbar

The toolbar configuration.

Type	object
Configurability	Inspector > Content > Add-ons > Toolbar
Default	null

Object Properties

showAutoscale

Whether to show the Autoscale button.

Type	boolean
Format	True/False
Configurability	Inspector
Default	null

Examples

falsetrue

---

showBoxSelect

Whether to show the Box select button.

Type	boolean
Format	True/False
Configurability	Inspector
Default	null

Examples

falsetrue

---

showLassoSelect

Whether to show the Lasso select button.

Type	boolean
Format	True/False
Configurability	Inspector
Default	null

Examples

falsetrue

---

showPan

Whether to show the Pan button.

Type	boolean
Format	True/False
Configurability	Inspector
Default	null

Examples

falsetrue

---

showResetViews

Whether to show the Reset view button.

Type	boolean
Format	True/False
Configurability	Inspector
Default	null

Examples

falsetrue

---

showToImage

Whether to show the Download as PNG button.

Type	boolean
Format	True/False
Configurability	Inspector
Default	null

Examples

falsetrue

---

showZoomIn

Whether to show the Zoom in button.

Type	boolean
Format	True/False
Configurability	Inspector
Default	null

Examples

falsetrue

---

showZoomOut

Whether to show the Zoom out button.

Type	boolean
Format	True/False
Configurability	Inspector
Default	null

Examples

falsetrue

---

showZoomSelect

Whether to show the Zoom select button.

Type	boolean
Format	True/False
Configurability	Inspector
Default	null

Examples

falsetrue

---

---

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

funnelChart.scrollIntoView()

Scrolls the canvas or parent container so that the selected component appears in the visible area.

Definition

funnelChart.scrollIntoView(options)

Parameters

options

The scroll options.

Type

object

Object Properties

behavior

The scroll behavior.

Type	string
Allowed Values	Value Description auto Scroll immediately to the specified position. smooth Scroll gradually to the specified position.

---

block

The scroll position relative to the component.

Type	string
Allowed Values	Value Description nearest Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view. start Scrolls to position the component at the top of the visible area. center Scrolls to position the component in the middle of the visible area. end Scrolls to position the component at the bottom of the visible area.

---

---

Examples

Scroll the minimum amount to immediately bring funnelChart into view.

funnelChart.scrollIntoView({behavior: 'auto', block: 'nearest'});

---

funnelChart.setHidden()

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

Definition

funnelChart.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide funnelChart.

funnelChart.setHidden(true);

Unhide funnelChart.

funnelChart.setHidden(false);

---

Events

Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.

Event	Description
Clear	A value is cleared.
Hover	An item is hovered over.
Legend Click	A legend item is clicked or pressed.
Legend Double Click	A legend item is double-clicked or pressed.
Select	A value is selected.
Unhover	An item is no longer hovered over.