Indicates whether automatic updates are currently paused.
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 />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" />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 />Represents height in pixels Can be any valid CSS size specifier. If not specified, defaults to the published height of the view.
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>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>Indicates whether tabs are hidden or shown.
<tableau-viz id="tableauViz" hide-tabs />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 />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" />An event raised when a custom mark context menu is clicked.
<tableau-viz id="tableauViz" onCustomMarkContextMenuEvent="onCustomMarkContextMenuEventHandler" />An event raised when a custom view has finished loading. This event is raised after the callback function for FirstInteractive (if any) has been called.
<tableau-viz id="tableauViz" onCustomViewLoaded="onCustomViewLoadedHandler" />An event raised when a custom view has been removed.
<tableau-viz id="tableauViz" onCustomViewRemoved="onCustomViewRemovedHandler" />An event raised when a custom view has been saved (newly created or updated).
<tableau-viz id="tableauViz" onCustomViewSaved="onCustomViewSavedHandler" />An event raised when a custom view has been set as the default view for a workbook.
<tableau-viz id="tableauViz" onCustomViewSetDefault="onCustomViewSetDefaultHandler" />An event raised when the user clicks on the Edit Button.
<tableau-viz id="tableauViz" onEditButtonClicked="onEditButtonClickedHandler" />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" />An event raised when any filter has changed state. You can use this event type with TableauViz objects.
<tableau-viz id="tableauViz" onFilterChanged="onFilterChangedHandler" />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" />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" />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" />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" />An event raised after a new story point becomes active.
<tableau-viz id="tableauViz" onStoryPointSwitched="onStoryPointSwitchedHandler" />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" />An event raised when a toolbar button or control becomes available or becomes unavailable.
<tableau-viz id="tableauViz" onToolbarStateChanged="onToolbarStateChangedHandler" />An event raised when a URL action occurs. See the UrlActionEvent class.
<tableau-viz id="tableauViz" onUrlAction="onUrlActionHandler" />The viz src
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>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" />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" />Indicates whether to touch optimize viz controls.
<tableau-viz id="tableauViz" touch-optimize />
<tableau-authoring-viz id="tableauViz" touch-optimize />Represents width in pixels Can be any valid CSS size specifier. If not specified, defaults to the published width of the view.
One Workbook is supported per visualization.
Adds an event listener to the specified event.
async function getSelectedMarks(event) {
const marksSelected = await event.detail.getMarksAsync();
const numMarks = marksSelected.data[0].data.length;
console.log(`${numMarks} marks Selected`);
}
let viz = document.getElementById('tableauViz');
viz.addEventListener("markselectionchanged", getSelectedMarks);Use this method to filter the viz before initialization. If used after initialization, it will re-render the viz.
For filtering after initialization, use the other filtering methods, such as applyFilterAsync.
If you add the same filter fields using the addFilter() method and by using the <viz-filter> element in the <tableau-viz> web component,
you might experience unexpected behavior.
The name of the field to filter on.
Single value or a list of comma separated values to filter on.
viz.addFilter('Region', 'Central,West');Display one of the export dialogs based on the dialogType parameter
Throws an error if dialogType is invalid
Exports the crosstab of any given worksheet within the current view to a specified format (CrosstabFileFormat.Excel, CrosstabFileFormat.CSV). Throws an error if the sheet name does not match any worksheets within the active sheet. Throws an error if the crosstab file failed to be created. Note: exportCrosstabAsync resolves when a download is initiated. It does not indicate that a download was successful or if the download was complete.
let viz = document.getElementById('tableauViz');
viz.exportCrosstabAsync('Sales by Segment', CrosstabFileFormat.CSV);Exports the summary data shown in the View Data window (shown when you click Download > Data from the toolbar for any given worksheet within the current view). The current file format is CSV. There is no limitation on the amount of summary data you can export. Throws an error if the sheet name does not match any worksheets within the active sheet. Throws an error if the CSV file failed to be created. Note: exportDataAsync resolves when a download is initiated. It does not indicate that a download was successful or if the download was complete.
let viz = document.getElementById('tableauViz');
const activeSheet = viz.workbook.activeSheet;
if (activeSheet.sheetType === SheetType.Worksheet) {
const columns = await activeSheet.getSummaryColumnsInfoAsync();
// Getting fieldId's for Latitude and Longitude columns
const columnsToIncludeById = columns.map((column) => {
if (column.fieldName === 'Latitude' || column.fieldName === 'Longitude') {
return column.fieldId;
}
});
await viz.exportDataAsync(activeSheet.name, { columnsToIncludeById });
}
else if (activeSheet.sheetType === SheetType.Dashboard) {
// Exporting the summary data for each worksheet in the dashboard while also ignoring aliases
for (const worksheet of activeSheet.worksheets) {
await viz.exportDataAsync(worksheet.name, { ignoreAliases: true });
}
}
else
{
// activeSheet is a Story and we want to export worksheets within the current view
const containedSheet = activeSheet.activeStoryPoint.containedSheet;
if (containedSheet !== undefined && containedSheet.sheetType === SheetType.Worksheet) {
// Exporting summary data of a worksheet within the active story point
await viz.exportDataAsync(containedSheet.name);
} else if (containedSheet !== undefined && containedSheet.sheetType === SheetType.Dashboard) {
// Exporting the summary data for each worksheet within the active story point
for (const worksheet of containedSheet.worksheets) {
await viz.exportDataAsync(worksheet.name);
}
}
}Equivalent to clicking on Download > Image from the toolbar, which creates a PNG file of the current visualization.
Exports the list of sheets with the given ExportPDFOptions options. If no sheets are specified, the current sheet is exported. The list of sheets can either exclusively include the worksheets within a dashboard or exclusively include the published sheets from the workbook. If no ExportPDFOptions are specified, the default settings are: Scaling = Automatic, PageSize = Letter, and Orientation = Portrait.
Throws an error if the list of sheets contains both worksheets within a dashboard and published sheets from the workbook. Throws an error if the PDF file fails to be created.
Note: exportPDFAsync resolves when a download is initiated. It does not indicate that a download was successful or if the download was complete.
let viz = document.getElementById('tableauViz');
const workbook = viz.workbook;
const activeSheet = workbook.activeSheet;
if (activeSheet.sheetType === SheetType.Worksheet || activeSheet.sheetType === SheetType.Story) {
await viz.exportPDFAsync();
} else if (activeSheet.sheetType === SheetType.Dashboard) {
const worksheetNames = activeSheet.worksheets.map((worksheet) => worksheet.name);
await viz.exportPDFAsync(worksheetNames);
}
// exporting all sheets within the workbook to PDF
const publishedSheetNames = workbook.publishedSheetsInfo.map((publishedSheetInfo) => publishedSheetInfo.name);
await viz.exportPDFAsync(publishedSheetNames);Exports the list of sheets to a PowerPoint file. If no sheets are specified, the current sheet is exported. The order the sheets appear in the list is the order the sheets appear in the PowerPoint file. The list of sheets can either exclusively include the worksheets within a dashboard or exclusively include the published sheets from the workbook.
Throws an error if the list of sheets contains both worksheets within a dashboard and published sheets from the workbook. Throws an error if the PowerPoint file fails to be created.
Note: exportPowerPointAsync resolves when a download is initiated. It does not indicate that a download was successful or if the download was complete.
let viz = document.getElementById('tableauViz');
const workbook = viz.workbook;
const activeSheet = workbook.activeSheet;
if (activeSheet.sheetType === SheetType.Worksheet || activeSheet.sheetType === SheetType.Story) {
await viz.exportPowerPointAsync();
} else if (activeSheet.sheetType === SheetType.Dashboard) {
const worksheetNames = activeSheet.worksheets.map((worksheet) => worksheet.name);
await viz.exportPowerPointAsync(worksheetNames);
}
// exporting all sheets within the workbook to PowerPoint
const publishedSheetNames = workbook.publishedSheetsInfo.map((publishedSheetInfo) => publishedSheetInfo.name);
await viz.exportPowerPointAsync(publishedSheetNames);Gets the visualization's current URL.
Pause layout updates. This is useful if you are resizing the visualization or performing multiple calls that could affect the layout.
Redoes the last action performed on a sheet.
Equivalent to clicking on the Refresh Data toolbar button.
Removes an event listener from the specified event.
let viz = document.getElementById('tableauViz');
viz.removeEventListener("markselectionchanged", getSelectedMarks);Resume layout updates.
Equivalent to clicking on the Revert All toolbar button, which restores the workbook to its starting state.
Toggle layout updates.
Undoes the last action performed on a sheet.
The interface for the top level Viz object.