The Sankey Chart component for Retool Apps

A content area to display sankey charts.

The Sankey Chart component renders data as links between nodes. Sankey Chart is useful for visualizing how data moves between different stages or categories.

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

Demo

Settings

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

Chart typeNode colorsHiddenShow on desktopShow on mobileMaintain space when hiddenMarginAllow duplicate nodes at different stepsDataLink hover label formatNode hover label formatAlways show in edit modeStyles

Properties

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

chartType

enum

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.

---

colorArray

string[]

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

---

colorArrayDropDown

string[]

The color scale for the chart, manually selected.

---

colorInputMode

enum

The mode for the color input.

---

global

boolean

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

---

gradientColorArray

object[]

The color scale for the chart.

---

hidden

boolean

Whether the component is visible.

---

id

string

The unique identifier.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

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.

---

maintainSpaceWhenHidden

boolean

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

---

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

---

paperBgColor

string

The paper background color.

---

plotBgColor

string

The plot background color.

---

pluginType

string

The plugin type.

---

sankeyAllowDuplicateNodesAtDifferentSteps

boolean

Whether to allow duplicate nodes at different steps.

---

sankeyDatasource

object

The data source for the Sankey Chart.

---

sankeyDatasourceMode

enum

The data mode for the Sankey Chart.

Values

manual	Manual.
source	Source.

---

sankeyLinkColorArray

array

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

---

sankeyLinkColorArrayDropDown

string

The link color scale for the chart, manually selected.

---

sankeyLinkGradientColorArray

array

The link color scale for the chart.

---

sankeyLinkHoverTemplate

string

The template for the hover information.

---

sankeyLinkHoverTemplateMode

enum

The mode of the hover information editor.

Values

manual	Manual.
source	Source.

---

sankeyMode

enum

The mode of the sankey data.

Values

manual	Manual.
source	Source.

---

sankeyNodeHoverTemplate

string

The template for the hover information.

---

sankeyNodeHoverTemplateMode

enum

The mode of the hover information editor.

Values

manual	Manual.
source	Source.

---

selectedPoints

object[]

A list of selected points.

---

showInEditor

boolean

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

---

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.

---

Methods

JavaScript API methods for interacting with Sankey 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.

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

sankeyChart.setHidden(hidden)

Parameters

hidden

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.

---