--- schema_version: "1" id: b423bab947a147f98e1b0b6b5a450e540a6816724832d95e79414ad12782315c title: PulseActions | Tableau Embedding API collection: tableau version: current locale: en-us portal_url: https://docs.salesforce.com/tableau/current/en-us/api/embedding_api/reference/interfaces/PulseActions.md canonical_url: https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html source_site: help.tableau.com content_type: documentation content_hash: c703b4b3d7ece707f107119bce010bcc564a4b292233cdcd3ec5086e6dc753c5 description: Documentation for Tableau Embedding API --- - PulseActions # Interface PulseActions Actions related to events and state of the Pulse metric interface PulseActions {     [addFilter](#addfilter-1)(fieldName: string, value: string): void;     [applyFilterAsync](#applyfilterasync-1)(         fieldName: string,         values: [PulseFieldValueArray](https://help.tableau.com/current/api/embedding_api/en-us/reference/types/PulseFieldValueArray.html),         updateType: [FilterUpdateType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FilterUpdateType.html),         options: [FilterOptions](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/FilterOptions.html),     ): Promise;     [applyFiltersAsync](#applyfiltersasync-1)(         filters: {             fieldName: string;             options: [FilterOptions](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/FilterOptions.html);             updateType: [FilterUpdateType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FilterUpdateType.html);             values: [PulseFieldValueArray](https://help.tableau.com/current/api/embedding_api/en-us/reference/types/PulseFieldValueArray.html);         }\[\],     ): Promise;     [applyTimeDimensionAsync](#applytimedimensionasync-1)(timeDimension: [PulseTimeDimension](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/PulseTimeDimension.html)): Promise;     [clearAllFiltersAsync](#clearallfiltersasync-1)(): Promise;     [clearFilterAsync](#clearfilterasync-1)(fieldNames: string): Promise;     [clearFiltersAsync](#clearfiltersasync-1)(fieldNames: string\[\]): Promise;     [getFiltersAsync](#getfiltersasync-1)(): Promise<[PulseFilter](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseFilter.html)\[\]\>;     [getTimeDimensionAsync](#gettimedimensionasync-1)(): Promise<[PulseTimeDimension](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/PulseTimeDimension.html)\>;     [resize](#resize-1)(): void; } #### Hierarchy ([View Summary](https://help.tableau.com/current/api/embedding_api/en-us/reference/hierarchy.html#PulseActions)) - PulseActions - [Pulse](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Pulse.html) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:179 ##### Index ### Methods [addFilter](#addfilter) [applyFilterAsync](#applyfilterasync) [applyFiltersAsync](#applyfiltersasync) [applyTimeDimensionAsync](#applytimedimensionasync) [clearAllFiltersAsync](#clearallfiltersasync) [clearFilterAsync](#clearfilterasync) [clearFiltersAsync](#clearfiltersasync) [getFiltersAsync](#getfiltersasync) [getTimeDimensionAsync](#gettimedimensionasync) [resize](#resize) ## Methods ### addFilter[](#addfilter) - addFilter(fieldName: string, value: string): void[](#addfilter-1) 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 `` element in the `` web component, you might experience unexpected behavior. #### Parameters - fieldName: string The name of the field to filter on. - value: string Single value or a list of comma separated values to filter on. ``` pulse.addFilter('Region', 'Central,West'); ``` #### Returns void - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:269 ### applyFilterAsync[](#applyfilterasync) - applyFilterAsync(     fieldName: string,     values: [PulseFieldValueArray](https://help.tableau.com/current/api/embedding_api/en-us/reference/types/PulseFieldValueArray.html),     updateType: [FilterUpdateType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FilterUpdateType.html),     options: [FilterOptions](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/FilterOptions.html), ): Promise[](#applyfilterasync-1) Applies the list of provided categorical filter values to the Pulse metric. #### Parameters - fieldName: string The name of the field to filter on. - values: [PulseFieldValueArray](https://help.tableau.com/current/api/embedding_api/en-us/reference/types/PulseFieldValueArray.html) The list of values to filter on. - updateType: [FilterUpdateType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FilterUpdateType.html) The update type of this filter (add, all, remove, replace). - options: [FilterOptions](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/FilterOptions.html) #### Returns Promise The field name that the filter is applied on. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:189 ### applyFiltersAsync[](#applyfiltersasync) - applyFiltersAsync(     filters: {         fieldName: string;         options: [FilterOptions](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/FilterOptions.html);         updateType: [FilterUpdateType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FilterUpdateType.html);         values: [PulseFieldValueArray](https://help.tableau.com/current/api/embedding_api/en-us/reference/types/PulseFieldValueArray.html);     }\[\], ): Promise[](#applyfiltersasync-1) Applies at least one categorical filter value to the Pulse metric. #### Parameters - filters: {     fieldName: string;     options: [FilterOptions](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/FilterOptions.html);     updateType: [FilterUpdateType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/FilterUpdateType.html);     values: [PulseFieldValueArray](https://help.tableau.com/current/api/embedding_api/en-us/reference/types/PulseFieldValueArray.html); }\[\] The set of filters to apply. #### Returns Promise The field names that the filter was applied on. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:202 ### applyTimeDimensionAsync[](#applytimedimensionasync) - applyTimeDimensionAsync(timeDimension: [PulseTimeDimension](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/PulseTimeDimension.html)): Promise[](#applytimedimensionasync-1) Applies the time dimension to the Pulse metric. #### Parameters - timeDimension: [PulseTimeDimension](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/PulseTimeDimension.html) The time dimension to apply #### Returns Promise - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:224 ### clearAllFiltersAsync[](#clearallfiltersasync) - clearAllFiltersAsync(): Promise[](#clearallfiltersasync-1) Resets all the existing filters on the Pulse metric. #### Returns Promise - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:253 ### clearFilterAsync[](#clearfilterasync) - clearFilterAsync(fieldNames: string): Promise[](#clearfilterasync-1) Resets the existing filter for the given field on the Pulse metric. #### Parameters - fieldNames: string #### Returns Promise The field to clear filter on. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:240 ### clearFiltersAsync[](#clearfiltersasync) - clearFiltersAsync(fieldNames: string\[\]): Promise[](#clearfiltersasync-1) Resets the existing filter for the given fields on the Pulse metric. #### Parameters - fieldNames: string\[\] The name of the fields to clear filter on. #### Returns Promise The fields to clear filter on. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:248 ### getFiltersAsync[](#getfiltersasync) - getFiltersAsync(): Promise<[PulseFilter](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseFilter.html)\[\]\>[](#getfiltersasync-1) Gets a list of filters for the Pulse metric. #### Returns Promise<[PulseFilter](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseFilter.html)\[\]\> The list of filters. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:231 ### getTimeDimensionAsync[](#gettimedimensionasync) - getTimeDimensionAsync(): Promise<[PulseTimeDimension](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/PulseTimeDimension.html)\>[](#gettimedimensionasync-1) Gets the current time dimension applied to the Pulse metric. #### Returns Promise<[PulseTimeDimension](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/PulseTimeDimension.html)\> The current time dimension. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:216 ### resize[](#resize) - resize(): void[](#resize-1) 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); ``` #### Returns void - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:281 ### Settings Member Visibility - Protected - Inherited - External ThemeOSLightDark ### On This Page Methods [addFilter](#addfilter)[applyFilterAsync](#applyfilterasync)[applyFiltersAsync](#applyfiltersasync)[applyTimeDimensionAsync](#applytimedimensionasync)[clearAllFiltersAsync](#clearallfiltersasync)[clearFilterAsync](#clearfilterasync)[clearFiltersAsync](#clearfiltersasync)[getFiltersAsync](#getfiltersasync)[getTimeDimensionAsync](#gettimedimensionasync)[resize](#resize)