The Plotly JSON Chart component for Retool Apps
A content area to display custom charts.
Use the Plotly JSON Chart component to build charts with raw Plotly JSON structured data. Plotly JSON Chart is useful for visualizing data when you need full control over the data and layout of the chart.
Refer to the charts guide for more information on building charts.
Settings
Plotly JSON Chart includes the following configurable options when building apps in the IDE.
Chart typeShow on desktopShow on mobileMaintain space when hiddenMarginDataLayoutAlways show in edit modeStyles |
Properties
All properties for Plotly JSON Chart with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
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
Whether the object is globally scoped for use in all app pages.
id
The unique identifier.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
linkColorArray
The link color scale for the chart, input as an array of colors.
linkColorArrayDropDown
The link color scale for the chart, manually selected.
linkColorInputMode
The input mode for the link color scale.
Values
colorArray | Color array. |
gradientColorArray | Gradient color array. |
colorArrayDropDown | Color array dropdown. |
linkGradientColorArray
The link color scale for the chart.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
plotlyDataJson
The data to be displayed in the chart in Plotly JSON format.
plotlyLayoutJson
The layout of the chart in Plotly JSON format.
pluginType
The plugin type.
selectedPoints
A list of selected points.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
title
The text to display as a title.
Methods
JavaScript API methods for interacting with Plotly JSON 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.
plotlyJsonChart.scrollIntoView(scrollIntoViewOptions)
Parameters
scrollIntoViewOptions
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
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.
plotlyJsonChart.setHidden(hidden)
Parameters
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.