Skip to main content

Get Show Me Options

Available November 2026 and later.

Call this before applying Show Me. Use only a returned showMeType whose isApplicable value is true; never invent or infer a type. If multiple applicable choices fit but the user's intent is unclear, ask the user to choose.

APIs called​

Talks to the open Tableau Studio workbook through the External Client API.

  • Call this before applying Show Me.

Required arguments​

worksheet​

Worksheet name or stable id.

Optional arguments​

session​

Session ID; optional if pinned or unique.

dataSource​

Optional datasource name or caption.

note

The tool refuses, and Show Me was not called, when dataSource was not found or is ambiguous. Candidates: each workbook datasource as its caption and internal name.

  • dataSource "${}" was not found or is ambiguous. Candidates: ${}. Show Me was not called.

fieldsSelectedInSchemaViewer​

Optional ordered fields. Captions and [datasource caption].[field] resolve to Tableau identities; omit for schema selection, [] selects none.

note

Show Me was not called when a selected field does not resolve. The refusal names that entry's index and the value you passed. The value uses a datasource qualifier that was not found or is ambiguous (candidates are caption and internal name), conflicts with dataSource, is ambiguous, was not found, or was not found in the resolved datasource. Field candidates, when listed, are caption and column reference, at most five.

  • fieldsSelectedInSchemaViewer[${}] "${}" ${}.${} Show Me was not called.