Use this method to filter the Pulse metric before initialization. If used after initialization, it will re-render the metric.
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 <pulse-filter>
element in the <tableau-pulse>
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.
pulse.addFilter('Region', 'Central,West');
Applies the list of provided categorical filter values to the Pulse metric.
The name of the field to filter on.
The list of values to filter on.
The update type of this filter (add, all, remove, replace).
The field name that the filter is applied on.
Applies at least one categorical filter value to the Pulse metric.
The field names that the filter was applied on.
Applies the time dimension to the Pulse metric.
The time dimension to apply
Resets all the existing filters on the Pulse metric.
Resets the existing filter for the given field on the Pulse metric.
The field to clear filter on.
Resets the existing filter for the given fields on the Pulse metric.
The name of the fields to clear filter on.
The fields to clear filter on.
Gets a list of filters for the Pulse metric.
The list of filters.
Gets the current time dimension applied to the Pulse metric.
The current time dimension.
Use this method to readjust the dimensions of the embedded Pulse metric in response to things like a window resize, device orientation change, or parent container resize.
window.addEventListener('resize', () => pulse.resize());
new ResizeObserver(() => pulse.resize()).observe(pulse.parentElement);
Actions related to events and state of the Pulse metric