The Tableau component for Retool Apps

A content area to display a Tableau visualization.

Version: Self-hosted 3.114 Stable

Tableau embeds a Tableau visualization dashboard.

Demo

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.

hidden

Whether this object is hidden from view.

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

Examples

true

---

id

The unique identifier (name).

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

Examples

query1

button1

---

selectedMarks

The selected marks.

Type	array
Array values	object
Mutability	Control Usage Retool UI Inspector

---

sheetData

The data in the sheet.

Type	array
Array values	array
Mutability	Control Usage Retool UI Inspector

---

sheetNames

The names of the sheets in the workbook.

Type	array
Array values	string
Mutability	Read-only

---

style

Custom style options.

Type	object
Mutability	Control Usage Retool UI Inspector > Appearance

---

tableauUrl

The URL of the Tableau dashboard.

Type	string
Mutability	Control Usage Retool UI Inspector

---

Methods

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

tableau.scrollIntoView()

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

Definition

tableau.scrollIntoView(options)

Parameters

options Required

object

The scroll options.

Object Properties

behavior Required

string

The scroll behavior.

Supported Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

block Required

string

The scroll position relative to the component.

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

Examples

Scroll the minimum amount to immediately bring tableau into view.

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

---

Events

Events triggered by user interactions. Use event handlers to trigger queries or other actions in response to events.