Skip to main content

Set Member Colors

Available November 2026 and later.

Set colors for members of the discrete field on a worksheet's Color.

APIs called​

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

  • Set colors for members of the discrete field on a worksheet's Color.

Required arguments​

worksheetName​

Worksheet name/id.worksheet

colors​

Member value; true or false for a boolean field.

Optional arguments​

session​

Session ID; optional if pinned or unique.

field​

Name or caption of the field on Color; needed only when panes color different fields.

Notes and caveats​

  • The color field's datasource must already be in the workbook. If it is not, the tool refuses with Datasource "name" is not in the workbook, where name is the datasource resolved from the Color encoding.