Indicates whether automatic updates are currently paused.
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
Equivalent to clicking on Download > Image from the toolbar, which creates a PNG file of the current visualization.
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.
Partially implemented - Actions related to events and state of the viz