Interface VizSettings

The options for configuring a viz in view mode.

interface VizSettings {
    debug?: boolean;
    device?: DeviceType;
    disableUrlActionsPopups?: boolean;
    hideEditButton?: boolean;
    hideEditInDesktopButton?: boolean;
    hideTabs?: boolean;
    iframeAttributeClass?: string;
    iframeAttributeLoading?: string;
    iframeAttributeStyle?: string;
    iframeAuth?: boolean;
    instanceIdToClone?: string;
    onCustomMarkContextMenuEvent?: string;
    onCustomViewLoaded?: string;
    onCustomViewRemoved?: string;
    onCustomViewSaved?: string;
    onCustomViewSetDefault?: string;
    onEditButtonClicked?: string;
    onEditInDesktopButtonClicked?: string;
    onFilterChanged?: string;
    onFirstInteractive?: string;
    onFirstVizSizeKnown?: string;
    onMarkSelectionChanged?: string;
    onParameterChanged?: string;
    onStoryPointSwitched?: string;
    onSummaryDataChanged?: string;
    onTabSwitched?: string;
    onToolbarStateChanged?: string;
    onUrlAction?: string;
    suppressDefaultEditBehavior?: boolean;
    token?: string;
    toolbar?: Toolbar;
    touchOptimize?: boolean;
}

Hierarchy (View Summary)

VizSettingsShared
- VizSettings
  - Viz

Properties

`Optional`debug

debug?: boolean

Indicates whether the non-minified version of JavaScript is loaded. If specified (or set to true), the non-minified version is used for both the local component and the Tableau Server visualization (if enabled). If not specified (or set to false), the minified version of the JavaScript files are loaded.

<tableau-viz id="tableauViz" debug />
<tableau-authoring-viz id="tableauViz" debug />
<tableau-ask-data id="tableauAskData" debug />

`Optional`device

device?: DeviceType

Specifies a device layout for a dashboard, if it exists. Values can be default, desktop, tablet, or phone. If not specified, defaults to loading a layout based on the smallest dimension of the hosting iframe element.

<tableau-viz id="tableauViz"  device="desktop" />

`Optional`disableUrlActionsPopups

disableUrlActionsPopups?: boolean

Indicates whether to suppress the execution of URL actions. This option does not prevent the URL action event from being raised. You can use this option to change what happens when a URL action occurs. If set to true and you create an event listener for the URL_ACTION event, you can use an event listener handler to customize the actions.

<tableau-viz id="tableauViz" disable-url-actions />

`Optional`hideEditButton

hideEditButton?: boolean

Indicates whether the Edit button is hidden or visible. If not set, defaults to false, meaning that the Edit button is visible.

<tableau-viz id="tableauViz" hide-edit-button>

`Optional`hideEditInDesktopButton

hideEditInDesktopButton?: boolean

Indicates whether the Edit in Desktop button is hidden or visible. If not specified, defaults to false, meaning that the Edit in Desktop button is visible.

<tableau-viz id="tableauViz" hide-edit-in-desktop-button>
<tableau-authoring-viz id="tableauViz" hide-edit-in-desktop-button>

`Optional`hideTabs

hideTabs?: boolean

Indicates whether tabs are hidden or shown.

<tableau-viz id="tableauViz"  hide-tabs />

`Optional`iframeAttributeClass

iframeAttributeClass?: string

The value of the 'class' attribute of the embedded iframe providing access to any custom selectors defined in the <iframe-style> child tag.

<tableau-viz id="tableauViz" iframe-attr-class="red-border">
  <iframe-style>
    .red-border {
      border: 1px solid red;
    }
  </iframe-style>
</tableau-viz>

`Optional`iframeAttributeLoading

iframeAttributeLoading?: string

The value of the 'loading' attribute of the embedded iframe. See: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#loading

<tableau-viz id="tableauViz" iframe-attr-loading="lazy" />
<tableau-authoring-viz id="tableauViz" iframe-attr-loading="lazy" />
<tableau-pulse id="tableauPulse" iframe-attr-loading="lazy" />

`Optional`iframeAttributeStyle

iframeAttributeStyle?: string

The value of the 'style' attribute of the embedded iframe.

<tableau-viz id="tableauViz" iframe-attr-style="border: 1px solid red" />
<tableau-authoring-viz id="tableauViz" iframe-attr-style="border: 1px solid red" />
<tableau-pulse id="tableauPulse" iframe-attr-style="border: 1px solid red" />

`Optional`iframeAuth

iframeAuth?: boolean

Indicates whether to use the old auth mechanism for authentication which happens inside the iframe. If specified, VizLoadErrorEvents triggered due to auth failures will not be thrown.

<tableau-viz id="tableauViz" iframe-auth />
<tableau-authoring-viz id="tableauViz" iframe-auth />
<tableau-ask-data id="tableauAskData" iframe-auth />

`Optional`instanceIdToClone

instanceIdToClone?: string

Specifies the ID of an existing instance to make a copy (clone) of. This is useful if the user wants to continue analysis of an existing visualization without losing the state of the original. If the ID does not refer to an existing visualization, the cloned version is derived from the original visualization.

<tableau-viz id="tableauViz"  instance-id-to-clone="id1" />

`Optional`onCustomMarkContextMenuEvent

onCustomMarkContextMenuEvent?: string

An event raised when a custom mark context menu is clicked.

<tableau-viz id="tableauViz" onCustomMarkContextMenuEvent="onCustomMarkContextMenuEventHandler" />

`Optional`onCustomViewLoaded

onCustomViewLoaded?: string

An event raised when a custom view has finished loading. This event is raised after the callback function for TableauEventType.FirstInteractive (if any) has been called.

<tableau-viz id="tableauViz" onCustomViewLoaded="onCustomViewLoadedHandler" />

`Optional`onCustomViewRemoved

onCustomViewRemoved?: string

An event raised when a custom view has been removed.

<tableau-viz id="tableauViz" onCustomViewRemoved="onCustomViewRemovedHandler" />

`Optional`onCustomViewSaved

onCustomViewSaved?: string

An event raised when a custom view has been saved (newly created or updated).

<tableau-viz id="tableauViz" onCustomViewSaved="onCustomViewSavedHandler" />

`Optional`onCustomViewSetDefault

onCustomViewSetDefault?: string

An event raised when a custom view has been set as the default view for a workbook.

<tableau-viz id="tableauViz" onCustomViewSetDefault="onCustomViewSetDefaultHandler" />

`Optional`onEditButtonClicked

onEditButtonClicked?: string

An event raised when the user clicks on the Edit Button.

<tableau-viz id="tableauViz" onEditButtonClicked="onEditButtonClickedHandler" />

`Optional`onEditInDesktopButtonClicked

onEditInDesktopButtonClicked?: string

An event raised when the user clicks on the Edit In Desktop Button. You can use this event type with TableauViz objects.

<tableau-viz id="tableauViz" onEditInDesktopButtonClicked="onEditInDesktopButtonClickedHandler" />
<tableau-authoring-viz id="tableauViz" onEditInDesktopButtonClicked="onEditInDesktopButtonClickedHandler" />

`Optional`onFilterChanged

onFilterChanged?: string

An event raised when any filter has changed state. You can use this event type with TableauViz objects.

<tableau-viz id="tableauViz" onFilterChanged="onFilterChangedHandler" />

`Optional`onFirstInteractive

onFirstInteractive?: string

An event raised when the Viz object first becomes interactive. This is only raised once.

<tableau-viz id="tableauViz" "onFirstInteractive"="onFirstInteractiveHandler" />
<tableau-authoring-viz id="tableauViz" onFirstInteractive="onFirstInteractiveHandler" />

`Optional`onFirstVizSizeKnown

onFirstVizSizeKnown?: string

An event raised when the size of the viz is known. You can use this event to perform tasks such as resizing the elements surrounding the Viz object once the object's size has been established.

<tableau-viz id="tableauViz" "onFirstVizSizeKnown"="onFirstVizSizeKnownHandler" />
<tableau-authoring-viz id="tableauViz" onFirstVizSizeKnown="onFirstVizSizeKnownHandler" />

`Optional`onMarkSelectionChanged

onMarkSelectionChanged?: string

An event raised when the selected marks on a visualization have changed. You can use this event type with TableauViz objects.

<tableau-viz id="tableauViz" onMarkSelectionChanged="onMarkSelectionChangedHandler" />

`Optional`onParameterChanged

onParameterChanged?: string

An event raised when a parameter has had its value modified. You can use this event type with [[Parameter]] objects.

<tableau-viz id="tableauViz" onParameterChanged="onParameterChangedHandler" />

`Optional`onStoryPointSwitched

onStoryPointSwitched?: string

An event raised after a new story point becomes active.

<tableau-viz id="tableauViz" onStoryPointSwitched="onStoryPointSwitchedHandler" />

`Optional`onSummaryDataChanged

onSummaryDataChanged?: string

An event raised when the summary data on a visualization have changed. You can use this event type with TableauViz objects.

<tableau-viz id="tableauViz" onSummaryDataChanged="onSummaryDataChangedHandler" />

`Optional`onTabSwitched

onTabSwitched?: string

An event raised after a tab switch occurs (the active sheet has changed). Guarantees the viz object will be interactive after this.

<tableau-viz id="tableauViz" onTabSwitched="onTabSwitchedHandler" />

`Optional`onToolbarStateChanged

onToolbarStateChanged?: string

An event raised when a toolbar button or control becomes available or becomes unavailable.

<tableau-viz id="tableauViz" onToolbarStateChanged="onToolbarStateChangedHandler" />

`Optional`onUrlAction

onUrlAction?: string

An event raised when a URL action occurs. See the UrlActionEvent class.

<tableau-viz id="tableauViz" onUrlAction="onUrlActionHandler" />

`Optional`suppressDefaultEditBehavior

suppressDefaultEditBehavior?: boolean

Indicates whether the default edit behavior is suppressed. If not specified, defaults to false, meaning that the default edit behavior is not suppressed.

<tableau-viz id="tableauViz" suppress-default-edit-behavior>
<tableau-authoring-viz id="tableauViz" suppress-default-edit-behavior>

`Optional`token

token?: string

The token used for authorization

<tableau-viz id="tableauViz" token="some-token-containing-clientId" />
<tableau-authoring-viz id="tableauViz" token="some-token-containing-clientId" />
<tableau-ask-data id="tableauAskData" token="some-token-containing-clientId" />

`Optional`toolbar

toolbar?: Toolbar

Specifies the position of the toolbar, if it is shown. The values can be Toolbar.Top, Toolbar.Bottom or Toolbar.Hidden. If not specified, defaults to Toolbar.Bottom.

<tableau-viz id="tableauViz"  toolbar="hidden" />

`Optional`touchOptimize

touchOptimize?: boolean

Indicates whether to touch optimize viz controls.

<tableau-viz id="tableauViz" touch-optimize />
<tableau-authoring-viz id="tableauViz" touch-optimize />

VizSettings | Tableau Embedding API

Interface VizSettings

Hierarchy (View Summary)

Index

Properties

Properties

`Optional`debug

`Optional`device

`Optional`disableUrlActionsPopups

`Optional`hideEditButton

`Optional`hideEditInDesktopButton

`Optional`hideTabs

`Optional`iframeAttributeClass

`Optional`iframeAttributeLoading

`Optional`iframeAttributeStyle

`Optional`iframeAuth

`Optional`instanceIdToClone

`Optional`onCustomMarkContextMenuEvent

`Optional`onCustomViewLoaded

`Optional`onCustomViewRemoved

`Optional`onCustomViewSaved

`Optional`onCustomViewSetDefault

`Optional`onEditButtonClicked

`Optional`onEditInDesktopButtonClicked

`Optional`onFilterChanged

`Optional`onFirstInteractive

`Optional`onFirstVizSizeKnown

`Optional`onMarkSelectionChanged

`Optional`onParameterChanged

`Optional`onStoryPointSwitched

`Optional`onSummaryDataChanged

`Optional`onTabSwitched

`Optional`onToolbarStateChanged

`Optional`onUrlAction

`Optional`suppressDefaultEditBehavior

`Optional`token

`Optional`touchOptimize

Settings

On This Page

VizSettings | Tableau Embedding API

Interface VizSettings

Hierarchy (View Summary)

Index

Properties

Properties

Optionaldebug

Optionaldevice

OptionaldisableUrlActionsPopups

OptionalhideEditButton

OptionalhideEditInDesktopButton

OptionalhideTabs

OptionaliframeAttributeClass

OptionaliframeAttributeLoading

OptionaliframeAttributeStyle

OptionaliframeAuth

OptionalinstanceIdToClone

OptionalonCustomMarkContextMenuEvent

OptionalonCustomViewLoaded

OptionalonCustomViewRemoved

OptionalonCustomViewSaved

OptionalonCustomViewSetDefault

OptionalonEditButtonClicked

OptionalonEditInDesktopButtonClicked

OptionalonFilterChanged

OptionalonFirstInteractive

OptionalonFirstVizSizeKnown

OptionalonMarkSelectionChanged

OptionalonParameterChanged

OptionalonStoryPointSwitched

OptionalonSummaryDataChanged

OptionalonTabSwitched

OptionalonToolbarStateChanged

OptionalonUrlAction

OptionalsuppressDefaultEditBehavior

Optionaltoken

Optionaltoolbar

OptionaltouchOptimize

Settings

On This Page

`Optional`debug

`Optional`device

`Optional`disableUrlActionsPopups

`Optional`hideEditButton

`Optional`hideEditInDesktopButton

`Optional`hideTabs

`Optional`iframeAttributeClass

`Optional`iframeAttributeLoading

`Optional`iframeAttributeStyle

`Optional`iframeAuth

`Optional`instanceIdToClone

`Optional`onCustomMarkContextMenuEvent

`Optional`onCustomViewLoaded

`Optional`onCustomViewRemoved

`Optional`onCustomViewSaved

`Optional`onCustomViewSetDefault

`Optional`onEditButtonClicked

`Optional`onEditInDesktopButtonClicked

`Optional`onFilterChanged

`Optional`onFirstInteractive

`Optional`onFirstVizSizeKnown

`Optional`onMarkSelectionChanged

`Optional`onParameterChanged

`Optional`onStoryPointSwitched

`Optional`onSummaryDataChanged

`Optional`onTabSwitched

`Optional`onToolbarStateChanged

`Optional`onUrlAction

`Optional`suppressDefaultEditBehavior

`Optional`token

`Optional`toolbar

`Optional`touchOptimize