Interface VizActions

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);

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.

Throws an error if dialogType is invalid

let viz = document.getElementById('tableauViz');
viz.exportCrosstabAsync('Sales by Segment', CrosstabFileFormat.CSV);

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);
    }
  }
}

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);

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);

let viz = document.getElementById('tableauViz');
viz.removeEventListener("markselectionchanged", getSelectedMarks);