The Mixed Chart component for classic apps

A content area to display mixed charts.

Retool 4.34.2 StableApplies to classic apps. View docs for the new app builder.

The Mixed Chart component renders data on an x-axis and multiple y-axes, and it can combine several different chart types. Mixed Chart is useful for visualizing the relationship between several different datasets.

Demo

Best practice

For more information about using the Mixed 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.

barGap

The gap between bars relative to the size of the bars. This can be a number between 0 and 1.

Type	number
Format	Float
Configurability	Inspector > Appearance > Bar gap
Default	0.4

Examples

false0.1

---

barGroupGap

The gap between bars in a group relative to the size of the bars. This can be any number between 0 and 1.

Type	number
Format	Float
Configurability	Inspector > Appearance > Bar group gap
Default	0

Examples

false0.1

---

barMode

The list of bar modes.

Type	string
Format	Plain Text
Configurability	Inspector > Appearance > Bar mode
Allowed Values	Value UI Option Description stack Stack Stacked mode. group Group Grouped mode. overlay Overlay Overlay mode. relative Relative Relative mode.
Default	stack

Examples

false"stack"

---

barOrientation

The orientation of the bars.

Type	string
Format	Plain Text
Configurability	Inspector > Appearance > Bar orientation
Allowed Values	Value UI Option Description vertical Vertical Vertical orientation. horizontal Horizontal Horizontal orientation.
Default	vertical

Examples

false"vertical"

---

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	null

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

---

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

---

---

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	mixedChart1

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

---

rangeSlider

Whether to display a range slider.

Type	boolean
Configurability	Inspector > Content > Add-ons > Range slider
Default	null

---

selectedPoints

A list of selected points.

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

---

showSecondYAxis

Whether to show the second Y-axis.

Type	boolean
Configurability	Read-only
Default	null

---

stackedBarTotalsDataLabelPosition

The position of the stack data labels on a stacked bar chart.

Type	string
Configurability	Inspector
Allowed Values	Value Description center Center. inside Inside. outside Outside.
Default	null

---

style

Custom style options.

Type	object
Configurability	Inspector > Appearance > style
Default	null

---

title

The title text to display.

Type	string
Configurability	Inspector
Default	null

---

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

---

---

xAxis

The x-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

---

---

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

---

---

yAxis2

The second 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

---

---

Methods

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

mixedChart.scrollIntoView()

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

Definition

mixedChart.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 mixedChart into view.

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

---

mixedChart.setHidden()

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

Definition

mixedChart.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide mixedChart.

mixedChart.setHidden(true);

Unhide mixedChart.

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