Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Environment

The environment namespace provides a way to programmatically gather information about the environment in which the Extensions is running.

Hierarchy

  • Environment

Index

Properties

apiVersion

apiVersion: string
returns

The version of the API being used by the Extensions.

context

returns

Current context in which the Extensions is running (i.e. Desktop or Server).

Optional country

country: undefined | string
returns

The country of the Tableau instance that is running the Extension. The country is the ISO 3166 country string represented by the user specified language. If the user specified lanugage is Fran├žais (Canada), country is CA.

since

1.9.0 and Tableau 2022.2 If running against a Tableau version prior to 2022.2, country will be undefined.

language

language: string
returns

The language of the Tableau instance that is running the Extension. The language is the ISO 639 language string of the user specified language. If the user specified language is Fran├žais (Canada), language is fr.

locale

locale: string
returns

The OS locale of the environment in which the Extension is running. Tableau Server supports both a language and a locale. This is the locale as defined in RFC 5646 in lowercase. If the user specified locale is English (United States), the locale is en-us.

mode

returns

Current mode of the Extensions (i.e. authoring or viewing).

operatingSystem

operatingSystem: string
returns

The OS in which Tableau is running.

tableauVersion

tableauVersion: string
returns

The version of Tableau that is running the Extensions.

Optional workbookFormatting

workbookFormatting: WorkbookFormatting
returns

WorkbookFormatting contains an array of FormattingSheets that will get your formatting information from the workbook. The types of sheet formatting by Class Name Key: WorksheetTitle, Worksheet (body text), Tooltip, StoryTitle, and DashboardTitle These formatting sheets include the following CSS properties: fontName, fontSize, isFontBold, isFontItalic, isFontUnderlined, and color.

since

1.7.0 and Tableau 2021.4