Showing content from https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/viz.html below:
Viz | Embedding API
Properties automaticUpdatesArePaused
automaticUpdatesArePaused: boolean
Inherited from Viz.automaticUpdatesArePaused
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:150
Optional debug
debug: undefined | false | true
Inherited from WebComponentSettingsShared.debug
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:50
Optional device
Inherited from Viz.device
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:496
Optional disableUrlActionsPopups
disableUrlActionsPopups: undefined | false | true
Inherited from Viz.disableUrlActionsPopups
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:464
Optional height
height: string | number
Inherited from WebComponentLocalSettings.height
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:20
Optional hideEditButton
hideEditButton: undefined | false | true
Inherited from Viz.hideEditButton
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:517
Optional hideEditInDesktopButton
hideEditInDesktopButton: undefined | false | true
Inherited from Viz.hideEditInDesktopButton
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:408
Optional hideTabs
hideTabs: undefined | false | true
Inherited from Viz.hideTabs
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:473
Optional iframeAttributeClass
iframeAttributeClass: undefined | string
Inherited from WebComponentSettingsShared.iframeAttributeClass
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:101
Optional iframeAttributeLoading
iframeAttributeLoading: undefined | string
Inherited from WebComponentSettingsShared.iframeAttributeLoading
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:74
Optional iframeAttributeStyle
iframeAttributeStyle: undefined | string
Inherited from WebComponentSettingsShared.iframeAttributeStyle
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:85
Optional iframeAuth
iframeAuth: undefined | false | true
Inherited from WebComponentSettingsShared.iframeAuth
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:62
Optional instanceIdToClone
instanceIdToClone: undefined | string
Inherited from Viz.instanceIdToClone
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:508
Optional onCustomMarkContextMenuEvent
onCustomMarkContextMenuEvent: undefined | string
Inherited from Viz.onCustomMarkContextMenuEvent
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:541
Optional onCustomViewLoaded
onCustomViewLoaded: undefined | string
Inherited from Viz.onCustomViewLoaded
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:590
Optional onCustomViewRemoved
onCustomViewRemoved: undefined | string
Inherited from Viz.onCustomViewRemoved
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:598
Optional onCustomViewSaved
onCustomViewSaved: undefined | string
Inherited from Viz.onCustomViewSaved
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:606
Optional onCustomViewSetDefault
onCustomViewSetDefault: undefined | string
Inherited from Viz.onCustomViewSetDefault
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:614
Optional onEditButtonClicked
onEditButtonClicked: undefined | string
Inherited from Viz.onEditButtonClicked
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:525
Optional onEditInDesktopButtonClicked
onEditInDesktopButtonClicked: undefined | string
Inherited from Viz.onEditInDesktopButtonClicked
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:428
Optional onFilterChanged
onFilterChanged: undefined | string
Inherited from Viz.onFilterChanged
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:533
Optional onFirstInteractive
onFirstInteractive: undefined | string
Inherited from Viz.onFirstInteractive
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:447
Optional onFirstVizSizeKnown
onFirstVizSizeKnown: undefined | string
Inherited from Viz.onFirstVizSizeKnown
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:438
Optional onMarkSelectionChanged
onMarkSelectionChanged: undefined | string
Inherited from Viz.onMarkSelectionChanged
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:549
Optional onParameterChanged
onParameterChanged: undefined | string
Inherited from Viz.onParameterChanged
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:557
Optional onStoryPointSwitched
onStoryPointSwitched: undefined | string
Inherited from Viz.onStoryPointSwitched
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:622
Optional onSummaryDataChanged
onSummaryDataChanged: undefined | string
Inherited from Viz.onSummaryDataChanged
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:630
Optional onTabSwitched
onTabSwitched: undefined | string
Inherited from Viz.onTabSwitched
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:581
Optional onToolbarStateChanged
onToolbarStateChanged: undefined | string
Inherited from Viz.onToolbarStateChanged
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:565
Optional onUrlAction
onUrlAction: undefined | string
Inherited from Viz.onUrlAction
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:573
Optional src
src: string | null
Inherited from WebComponentLocalSettings.src
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:8
Optional suppressDefaultEditBehavior
suppressDefaultEditBehavior: undefined | false | true
Inherited from Viz.suppressDefaultEditBehavior
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:419
Optional token
token: undefined | string
Inherited from WebComponentSettingsShared.token
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:37
Optional toolbar
Inherited from Viz.toolbar
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:484
Optional touchOptimize
touchOptimize: undefined | false | true
Inherited from Viz.touchOptimize
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:397
Optional width
width: string | number
Inherited from WebComponentLocalSettings.width
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:14
Optional workbook
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:106
Methods addEventListener
- addEventListener(type: TableauEventType, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
addFilter
- addFilter(fieldName: string, value: string): void
displayDialogAsync
exportCrosstabAsync
exportDataAsync
exportImageAsync
- exportImageAsync(): Promise<void>
exportPDFAsync
- exportPDFAsync(sheetNames?: Array<string>, options?: ExportPDFOptions): Promise<void>
exportPowerPointAsync
- exportPowerPointAsync(sheetNames?: Array<string>): Promise<void>
getCurrentSrcAsync
- getCurrentSrcAsync(): Promise<string>
pauseAutomaticUpdatesAsync
- pauseAutomaticUpdatesAsync(): Promise<void>
redoAsync
- redoAsync(): Promise<void>
refreshDataAsync
- refreshDataAsync(): Promise<void>
removeEventListener
- removeEventListener(type: TableauEventType, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void
resize
resumeAutomaticUpdatesAsync
- resumeAutomaticUpdatesAsync(): Promise<void>
revertAllAsync
- revertAllAsync(): Promise<void>
setAuthToken
- setAuthToken(token: string): void
-
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/VizInterfaces.ts:112
Parameters
Returns void
toggleAutomaticUpdatesAsync
- toggleAutomaticUpdatesAsync(): Promise<void>
undoAsync
- undoAsync(): Promise<void>
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4