Skip to main content

Workbooks

Tools for reading and applying workbook XML, listing worksheets and dashboards, and activating sheets in the open workbook.

This category contains the tools:

  • Delete Sheet: Deletes a worksheet, dashboard, or storyboard from the workbook open in Tableau Studio, matching the target by name or id.
  • Activate Sheet: Activates an existing worksheet, dashboard, or storyboard in the open Tableau Studio workbook, bringing it to the foreground so it becomes the active sheet (_available September 2026 and later_ for storyboards and for matching by id).
  • Update Workbook: Applies modified workbook content to the workbook currently open in Tableau Studio, replacing it with the XML you supply.
  • Open File: Opens a local file in Tableau Studio by absolute path: a .twb/.twbx opens as a workbook, while a datasource file (Excel, .tds, extract, and the like) attaches to the open workbook.
  • Rename Sheet: Renames a worksheet, dashboard, or storyboard in the workbook open in Tableau Studio, matching the target by name or id.
  • Save Workbook: Saves the workbook currently open in Tableau Studio.
  • Export Workbook: Exports the workbook open in Tableau Studio to a file at filePath, leaving the open document unchanged.
  • Set Auto Updates Paused: Pause or resume automatic query execution for a worksheet, or for a dashboard and every worksheet it contains.
  • Undo or Redo: Undo reverses the most recent change to the open workbook (Edit > Undo).
  • Get Structure: Read the live structure of the open workbook, or of one existing sheet or datasource.
  • Publish Workbook: Opens the Publish Workbook dialog so the workbook open in the connected Tableau Studio instance can be published to the signed-in Tableau site.
  • Capture Window Screenshot: Capture the largest visible Tableau window by pixel area.
  • Close Workbook: Close the open workbook (File Close).
  • Get workbook extensions: Lists viz and dashboard extensions in the open workbook.
  • Reload Extensions: Reload the extension on a worksheet, or every extension on a dashboard.