The Chart component for Retool Apps

A content area to display charts.

Version: Cloud and 3.185 Edge

This component is considered legacy and will be deprecated in the future. Use the newer Chart components, which have more features available.

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.

autoSkipTicks

Whether to skip ticks that are not evenly spaced.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

cutoutPercentage

The percentage of the chart that is cut out of the middle.

Type	number
Mutability	Control Usage Retool UI Inspector

---

datasets

A list of datasets.

Type	array
Array values	object
Mutability	Control Usage Retool UI Inspector

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Hidden Method setHidden()
Default	false

Examples

true

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Default	legacyChart1

Examples

query1

button1

---

isHiddenOnDesktop

Whether to show or hide this object in the desktop layout.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Show on desktop
Default	false

Examples

true

---

isHiddenOnMobile

Whether to show or hide this object in the mobile layout.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Show on mobile
Default	true

Examples

true

---

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

true

---

margin

The amount of margin to render outside.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Spacing > Margin
Allowed Values	Value UI Option Description 4px 8px Normal Normal margin. 0 None No margin.
Default	4px 8px

Examples

4px 8px

---

showInEditor

Whether the component remains visible in the editor if hidden is true.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

true

---

style

Custom style options.

Type	object
Mutability	Control Usage Retool UI Inspector > Appearance > style

---

xAxisLabel

The label for the x-axis.

Type	string
Mutability	Control Usage Retool UI Inspector

---

xValues

A list of x-axis values.

Type	array
Array values	string
Mutability	Control Usage Retool UI Inspector

---

xValuesType

The type of x-axis values.

Type	string
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description number Number string String

---

yAxisLabel

The label for the y-axis.

Type	string
Mutability	Control Usage Retool UI Inspector

---

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.
Select	A value is selected.