Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface VizAuthoringSettings

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

Hierarchy

Index

Properties

Optional debug

debug: undefined | false | true

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 hideCloseButton

hideCloseButton: undefined | false | true

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

Optional hideEditInDesktopButton

hideEditInDesktopButton: undefined | false | true

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 iframeAttributeClass

iframeAttributeClass: undefined | string

The value of the 'class' attribute of the embedded iframe providing access to any custom selectors defined in the 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: undefined | 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: undefined | 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: undefined | false | true

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 onEditInDesktopButtonClicked

onEditInDesktopButtonClicked: undefined | 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 onFirstInteractive

onFirstInteractive: undefined | 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: undefined | 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 onWorkbookPublished

onWorkbookPublished: undefined | 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" />

Optional onWorkbookPublishedAs

onWorkbookPublishedAs: undefined | 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" />

Optional onWorkbookReadyToClose

onWorkbookReadyToClose: undefined | 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" />

Optional suppressDefaultEditBehavior

suppressDefaultEditBehavior: undefined | false | true

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: undefined | 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 touchOptimize

touchOptimize: undefined | false | true

Indicates whether to touch optimize viz controls.

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