---
schema_version: "1"
id: 81fddd570e7540be199f93c40824b57bc9d572b87882cb6605d7f1641b736a4b
title: WebComponentSettingsShared | 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/WebComponentSettingsShared.md
canonical_url: https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/WebComponentSettingsShared.html
source_site: help.tableau.com
content_type: documentation
content_hash: 0b182b033f15b1113858515243269d21b8d69922c252c27ec07b2e99d75a8d8e
description: Documentation for Tableau Embedding API
---
- WebComponentSettingsShared

# Interface WebComponentSettingsShared

This interface represents all of the options for configuring a webcomponent that are common between viz and askdata.

interface WebComponentSettingsShared {  
    [debug](#debug)?: boolean;  
    [iframeAttributeClass](#iframeattributeclass)?: string;  
    [iframeAttributeLoading](#iframeattributeloading)?: string;  
    [iframeAttributeStyle](#iframeattributestyle)?: string;  
    [iframeAuth](#iframeauth)?: boolean;  
    [token](#token)?: string;  
}

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

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

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

##### Index

### Properties

[debug?](#debug) [iframeAttributeClass?](#iframeattributeclass) [iframeAttributeLoading?](#iframeattributeloading) [iframeAttributeStyle?](#iframeattributestyle) [iframeAuth?](#iframeauth) [token?](#token)

## 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 />
```

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

### `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>
```

- 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" />
```

- 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" />
```

- 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 />
```

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

### `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" />
```

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

### Settings

Member Visibility

- Protected
- Inherited
- External

ThemeOSLightDark

### On This Page

Properties

[debug](#debug)[iframeAttributeClass](#iframeattributeclass)[iframeAttributeLoading](#iframeattributeloading)[iframeAttributeStyle](#iframeattributestyle)[iframeAuth](#iframeauth)[token](#token)