---
schema_version: "1"
id: cd6adfc5b99fabd96966d1d33ff3e3ae4804bb81ddf96abe473839b89cd4d1ee
title: VizAuthoringSettings | Tableau Embedding API
collection: tableau
version: current
locale: en-us
portal_url: https://docs.salesforce.com/tableau/current/en-us/api/embedding_api/reference/interfaces/VizAuthoringSettings.md
canonical_url: https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/VizAuthoringSettings.html
source_site: help.tableau.com
content_type: documentation
content_hash: 45e8757a3cf6e722c038e2316ca0f6f451fe48257278e1fa107f175db68d262b
description: Documentation for Tableau Embedding API
---
- VizAuthoringSettings

# Interface VizAuthoringSettings

(Beta) Represents the options for configuring a viz in authoring mode.

interface VizAuthoringSettings {  
    [debug](#debug)?: boolean;  
    [hideCloseButton](#hideclosebutton)?: boolean;  
    [hideEditInDesktopButton](#hideeditindesktopbutton)?: boolean;  
    [iframeAttributeClass](#iframeattributeclass)?: string;  
    [iframeAttributeLoading](#iframeattributeloading)?: string;  
    [iframeAttributeStyle](#iframeattributestyle)?: string;  
    [iframeAuth](#iframeauth)?: boolean;  
    [onEditInDesktopButtonClicked](#oneditindesktopbuttonclicked)?: string;  
    [onFirstInteractive](#onfirstinteractive)?: string;  
    [onFirstVizSizeKnown](#onfirstvizsizeknown)?: string;  
    [onWorkbookPublished](#onworkbookpublished)?: string;  
    [onWorkbookPublishedAs](#onworkbookpublishedas)?: string;  
    [onWorkbookReadyToClose](#onworkbookreadytoclose)?: string;  
    [suppressDefaultEditBehavior](#suppressdefaulteditbehavior)?: boolean;  
    [token](#token)?: string;  
    [touchOptimize](#touchoptimize)?: boolean;  
}

#### Hierarchy ([View Summary](https://help.tableau.com/current/api/embedding_api/en-us/reference/hierarchy.html#VizAuthoringSettings))

- VizSettingsShared
    - VizAuthoringSettings
        - [AuthoringViz](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/AuthoringViz.html)

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:685

##### Index

### Properties

[debug?](#debug) [hideCloseButton?](#hideclosebutton) [hideEditInDesktopButton?](#hideeditindesktopbutton) [iframeAttributeClass?](#iframeattributeclass) [iframeAttributeLoading?](#iframeattributeloading) [iframeAttributeStyle?](#iframeattributestyle) [iframeAuth?](#iframeauth) [onEditInDesktopButtonClicked?](#oneditindesktopbuttonclicked) [onFirstInteractive?](#onfirstinteractive) [onFirstVizSizeKnown?](#onfirstvizsizeknown) [onWorkbookPublished?](#onworkbookpublished) [onWorkbookPublishedAs?](#onworkbookpublishedas) [onWorkbookReadyToClose?](#onworkbookreadytoclose) [suppressDefaultEditBehavior?](#suppressdefaulteditbehavior) [token?](#token) [touchOptimize?](#touchoptimize)

## Properties

### `Optional`debug[](#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 />
```

Inherited from VizSettingsShared.debug

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:50

### `Optional`hideCloseButton[](#hideclosebutton)

hideCloseButton?: boolean

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

```
<tableau-authoring-viz id="tableauViz" hide-close-button />
```

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:693

### `Optional`hideEditInDesktopButton[](#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>
```

Inherited from VizSettingsShared.hideEditInDesktopButton

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:457

### `Optional`iframeAttributeClass[](#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>
```

Inherited from VizSettingsShared.iframeAttributeClass

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:101

### `Optional`iframeAttributeLoading[](#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](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" />
```

Inherited from VizSettingsShared.iframeAttributeLoading

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:74

### `Optional`iframeAttributeStyle[](#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" />
```

Inherited from VizSettingsShared.iframeAttributeStyle

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:85

### `Optional`iframeAuth[](#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 />
```

Inherited from VizSettingsShared.iframeAuth

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:62

### `Optional`onEditInDesktopButtonClicked[](#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" />
```

Inherited from VizSettingsShared.onEditInDesktopButtonClicked

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:477

### `Optional`onFirstInteractive[](#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" />
```

Inherited from VizSettingsShared.onFirstInteractive

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:496

### `Optional`onFirstVizSizeKnown[](#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" />
```

Inherited from VizSettingsShared.onFirstVizSizeKnown

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:487

### `Optional`onWorkbookPublished[](#onworkbookpublished)

onWorkbookPublished?: string

An event raised when the workbook has been published. This notification is sent when using embedded web authoring functionality.

```
<tableau-authoring-viz id="tableauViz" onWorkbookPublished="onWorkbookPublishedHandler" />
```

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:701

### `Optional`onWorkbookPublishedAs[](#onworkbookpublishedas)

onWorkbookPublishedAs?: string

An event raised when "publish as" is successful. This notification is sent when using embedded web authoring functionality.

```
<tableau-authoring-viz id="tableauViz" onWorkbookPublishedAs="onWorkbookPublishedAsHandler" />
```

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:709

### `Optional`onWorkbookReadyToClose[](#onworkbookreadytoclose)

onWorkbookReadyToClose?: string

An event raised when the workbook is ready to close. This notification is sent when using embedded web authoring functionality.

```
<tableau-authoring-viz id="tableauViz" onWorkbookReadyToClose="onWorkbookReadyToCloseHandler" />
```

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:717

### `Optional`suppressDefaultEditBehavior[](#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>
```

Inherited from VizSettingsShared.suppressDefaultEditBehavior

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:468

### `Optional`token[](#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" />
```

Inherited from VizSettingsShared.token

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:37

### `Optional`touchOptimize[](#touchoptimize)

touchOptimize?: boolean

Indicates whether to touch optimize viz controls.

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

Inherited from VizSettingsShared.touchOptimize

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:446

### Settings

Member Visibility

- Protected
- Inherited
- External

ThemeOSLightDark

### On This Page

Properties

[debug](#debug)[hideCloseButton](#hideclosebutton)[hideEditInDesktopButton](#hideeditindesktopbutton)[iframeAttributeClass](#iframeattributeclass)[iframeAttributeLoading](#iframeattributeloading)[iframeAttributeStyle](#iframeattributestyle)[iframeAuth](#iframeauth)[onEditInDesktopButtonClicked](#oneditindesktopbuttonclicked)[onFirstInteractive](#onfirstinteractive)[onFirstVizSizeKnown](#onfirstvizsizeknown)[onWorkbookPublished](#onworkbookpublished)[onWorkbookPublishedAs](#onworkbookpublishedas)[onWorkbookReadyToClose](#onworkbookreadytoclose)[suppressDefaultEditBehavior](#suppressdefaulteditbehavior)[token](#token)[touchOptimize](#touchoptimize)