Skip to main content

The Waterfall Chart component for Retool Apps

A content area to display waterfall charts.

The Waterfall Chart component renders data as a series of steps with sequential positive and negative values. Waterfall Chart is useful for visualizing how incremental values contribute to a total.

Refer to the charts guide for more information on building charts.

Demo

Settings​

Waterfall Chart includes the following configurable options when building apps in the IDE.

Chart typeShow on desktopShow on mobileLegend postitionMaintain space when hiddenMarginSeriesAlways show in edit modeStylesX-axisY-axis

Properties​

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

The type of chart to display.

Values
bar

Bar Chart or Stacked Bar Chart.

bubble

Bubble Chart.

funnel

Funnel Chart.

heatmap

Heat Map.

line

Line Chart or Sparkline.

mixed

Mixed Chart.

pie

Pie Chart.

plotlyJson

Plotly JSON Chart.

sankey

Sankey Chart.

scatter

Scatter Chart.

line

Sparkline.

sunburst

Sunburst Chart.

treemap

Treemap.

waterfall

Waterfall Chart.

global​

boolean

Whether the object is globally scoped for use in all app pages.

​

boolean

Whether the component is visible.

id​

string

The unique identifier.

Whether the component is visible in the desktop layout.

Whether the component is visible in the mobile layout.

The position of the legend.

Values
bottom

Bottom.

left

Left.

none

None.

right

Right.

left

Top.

linkColorArray​

array

The link color scale for the chart, input as an array of colors.

linkColorArrayDropDown​

string

The link color scale for the chart, manually selected.

linkColorInputMode​

enum

The input mode for the link color scale.

Values
colorArray

Color array.

gradientColorArray

Gradient color array.

colorArrayDropDown

Color array dropdown.

linkGradientColorArray​

array

The link color scale for the chart.

Whether the component takes up space on the canvas if hidden is true.

The amount of margin to render outside.

Values
4px 8px

Normal margin.

0

No margin.

pluginType​

string

The plugin type.

selectedPoints​

object[]

A list of selected points.

series​

object

The series data for the chart.

Properties

0​

object

The first series configuration and data.

Whether to remain visible in the editor if hidden is true.

showSecondYAxis​

boolean

Whether to show the second Y-axis.

style​

object

Custom style options in use. Not all style options may be available for all components.

title​

string

The text to display as a title.

xAxis​

object

The x-axis configuration.

Properties

lineWidth​

number

The width of the line.

The maximum value of the axis.

The minimum value of the axis.

The range mode of the axis.

Values
auto

Auto.

manual

Manual.

scale​

boolean

The scale of the axis.

Whether to show grid lines on the axis.

Whether to show the axis line.

Whether to show tick labels on the x-axis.

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

The sorting of the axis.

Values
none

None.

ascending

Ascending.

descending

Descending.

The format of the axis tick labels.

title​

string

The axis title.

yAxis​

object

The y-axis configuration.

Properties

lineWidth​

number

The width of the line.

The maximum value of the axis.

The minimum value of the axis.

The range mode of the axis.

Values
auto

Auto.

manual

Manual.

scale​

boolean

The scale of the axis.

Whether to show grid lines on the axis.

Whether to show the axis line.

Whether to show tick labels on the x-axis.

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

The sorting of the axis.

Values
none

None.

ascending

Ascending.

descending

Descending.

The format of the axis tick labels.

title​

string

The axis title.

Methods​

JavaScript API methods for interacting with Waterfall Chart. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

scrollIntoView​

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

waterfallChart.scrollIntoView(scrollIntoViewOptions)
Parameters

scrollIntoViewOptions​

object

The scroll options.

Properties

behavior​

enum

The scroll behavior.

Values
auto

Scroll immediately to the specified position.

smooth

Scroll gradually to the specified position.

block​

enum

The scroll position relative to the component.

Values
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.

setHidden​

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

waterfallChart.setHidden(hidden)
Parameters

​

boolean

Whether the component is visible.

Events​

Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.

clear​

The value is cleared.

hover​

A chart is hovered over.

legendClick​

A chart legend is clicked.

legendDoubleClick​

A chart legend is double clicked.

select​

A value is selected.

unhover​

A chart is no longer hovered over.