The Pie Chart component for Retool Apps
A content area to display pie charts.
The Pie Chart component renders data in a circle, with percentage-based slices. Pie Chart is useful for visualizing how different parts make up a whole.
Refer to the charts guide for more information on building charts.
Settings
Pie Chart includes the following configurable options when building apps in the IDE.
Properties
All properties for Pie 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. |
colorArray
The color scale for the chart, input as an array of colors.
colorArrayDropDown
The color scale for the chart, manually selected.
colorInputMode
The mode for the color input.
datasource
The data source.
datasourceMode
The data source mode.
Values
manual | Manual. |
source | Source. |
global
Whether the object is globally scoped for use in all app pages.
gradientColorArray
The color scale for the chart.
hoverInfo
The information displayed when hovering over a node.
id
The unique identifier.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
legendPosition
The position of the legend.
Values
bottom | Bottom. |
left | Left. |
none | None. |
right | Right. |
left | Top. |
linkColorArray
The link color scale for the chart, input as an array of colors.
linkColorArrayDropDown
The link color scale for the chart, manually selected.
linkGradientColorArray
The link color scale for the chart.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
pieDataHole
Specifies hole depth, between 0 and 1.
Information displayed when hovering over a slice.
Values
label | Label. |
value | Value. |
percent | Percent. |
label+value | Label and value. |
label+percent | Label and percent. |
percent+value | Percent and value. |
label+percent+value | Label, percent, and value. |
pieDataLabels
An array of labels for each pie slice.
pieDataLabelsMode
The mode for displaying labels.
Values
manual | Manual. |
source | Source. |
pieDataLineColor
The color of the line between slices.
pieDataLineWidth
The width of the line between slices.
pieDataTextInfo
The text that is displayed on each slice.
Values
label | Label. |
value | Value. |
percent | Percent. |
label+value | Label and value. |
label+percent | Label and percent. |
percent+value | Percent and value. |
label+percent+value | Label, percent, and value. |
pieDataTextPostition
pieDataValues
An array representing each slice size
pieDataValuesMode
The mode for displaying values.
Values
manual | Manual. |
source | Source. |
pluginType
The plugin type.
selectedPoints
A list of selected points.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
textInfo
The information displayed when clicking on a node.
title
The text to display as a title.
Methods
JavaScript API methods for interacting with Pie 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.
pieChart.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.
pieChart.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.