--- schema_version: "1" id: c4656f16a4a958b76f5e072cae656f1694db7da8c89c532a15f4d234ef246c3f title: Pulse | 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/Pulse.md canonical_url: https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Pulse.html source_site: help.tableau.com content_type: documentation content_hash: 480551310684f9a66d12bfaa971e1260a0847aed8665522afef5955e3e036ee9 description: Documentation for Tableau Embedding API --- - Pulse # Interface Pulse The interface for the top-level Pulse object. interface Pulse {     [disableExploreFilter](#disableexplorefilter)?: boolean;     [height](#height)?: string | number;     [iframeAttributeClass](#iframeattributeclass)?: string;     [iframeAttributeLoading](#iframeattributeloading)?: string;     [iframeAttributeStyle](#iframeattributestyle)?: string;     [layout](#layout)?: [PulseLayout](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/PulseLayout.html);     [src](#src)?: null | string;     [theme](#theme)?: string;     [timeDimension](#timedimension)?: [PulseTimeDimension](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/PulseTimeDimension.html);     [token](#token)?: string;     [width](#width)?: string | number;     [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#Pulse)) - [PulseSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html) - [PulseActions](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html) - Pulse - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:287 ##### Index ### Methods [addFilter](#addfilter) [applyFilterAsync](#applyfilterasync) [applyFiltersAsync](#applyfiltersasync) [applyTimeDimensionAsync](#applytimedimensionasync) [clearAllFiltersAsync](#clearallfiltersasync) [clearFilterAsync](#clearfilterasync) [clearFiltersAsync](#clearfiltersasync) [getFiltersAsync](#getfiltersasync) [getTimeDimensionAsync](#gettimedimensionasync) [resize](#resize) ### Properties [disableExploreFilter?](#disableexplorefilter) [height?](#height) [iframeAttributeClass?](#iframeattributeclass) [iframeAttributeLoading?](#iframeattributeloading) [iframeAttributeStyle?](#iframeattributestyle) [layout?](#layout) [src?](#src) [theme?](#theme) [timeDimension?](#timedimension) [token?](#token) [width?](#width) ## 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 Inherited from [PulseActions](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html).[addFilter](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html#addfilter) - 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. Inherited from [PulseActions](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html).[applyFilterAsync](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html#applyfilterasync) - 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. Inherited from [PulseActions](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html).[applyFiltersAsync](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html#applyfiltersasync) - 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 Inherited from [PulseActions](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html).[applyTimeDimensionAsync](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html#applytimedimensionasync) - 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 Inherited from [PulseActions](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html).[clearAllFiltersAsync](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html#clearallfiltersasync) - 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. Inherited from [PulseActions](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html).[clearFilterAsync](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html#clearfilterasync) - 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. Inherited from [PulseActions](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html).[clearFiltersAsync](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html#clearfiltersasync) - 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. Inherited from [PulseActions](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html).[getFiltersAsync](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html#getfiltersasync) - 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. Inherited from [PulseActions](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html).[getTimeDimensionAsync](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html#gettimedimensionasync) - 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 Inherited from [PulseActions](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html).[resize](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseActions.html#resize) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:281 ## Properties ### `Optional`disableExploreFilter[](#disableexplorefilter) disableExploreFilter?: boolean Indicates whether the explore filter is hidden or visible. ``` ``` Inherited from [PulseSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html).[disableExploreFilter](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html#disableexplorefilter) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:32 ### `Optional`height[](#height) height?: string | number Represents height in pixels Can be any valid CSS size specifier. If not specified, defaults to the published height of the view. Inherited from [PulseSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html).[height](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html#height) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:20 ### `Optional`iframeAttributeClass[](#iframeattributeclass) iframeAttributeClass?: string The value of the 'class' attribute of the embedded iframe providing access to any custom selectors defined in the `` child tag. ``` .red-border { border: 1px solid red; } ``` Inherited from [PulseSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html).[iframeAttributeClass](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html#iframeattributeclass) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:90 ### `Optional`iframeAttributeLoading[](#iframeattributeloading) iframeAttributeLoading?: string The value of the 'loading' attribute of the embedded iframe. See: [https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#loading](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#loading) ``` ``` Inherited from [PulseSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html).[iframeAttributeLoading](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html#iframeattributeloading) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:63 ### `Optional`iframeAttributeStyle[](#iframeattributestyle) iframeAttributeStyle?: string The value of the 'style' attribute of the embedded iframe. ``` ``` Inherited from [PulseSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html).[iframeAttributeStyle](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html#iframeattributestyle) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:74 ### `Optional`layout[](#layout) layout?: [PulseLayout](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/PulseLayout.html) Specifies the desired custom layout of the Pulse metric. ``` ``` Inherited from [PulseSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html).[layout](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html#layout) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:40 ### `Optional`src[](#src) src?: null | string The viz src Inherited from [PulseSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html).[src](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html#src) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:8 ### `Optional`theme[](#theme) theme?: string The Base64-encoded string representation of the Pulse theme object. Inherited from [PulseSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html).[theme](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html#theme) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:96 ### `Optional`timeDimension[](#timedimension) timeDimension?: [PulseTimeDimension](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/PulseTimeDimension.html) Specifies the desired time dimension to apply to the Pulse metric by default. ``` ``` Inherited from [PulseSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html).[timeDimension](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html#timedimension) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:104 ### `Optional`token[](#token) token?: string The token used for authorization ``` ``` Inherited from [PulseSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html).[token](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html#token) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/PulseInterfaces.ts:51 ### `Optional`width[](#width) width?: string | number Represents width in pixels Can be any valid CSS size specifier. If not specified, defaults to the published width of the view. Inherited from [PulseSettings](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html).[width](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/PulseSettings.html#width) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WebComponentInterfaces.ts:14 ### 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) Properties [disableExploreFilter](#disableexplorefilter)[height](#height)[iframeAttributeClass](#iframeattributeclass)[iframeAttributeLoading](#iframeattributeloading)[iframeAttributeStyle](#iframeattributestyle)[layout](#layout)[src](#src)[theme](#theme)[timeDimension](#timedimension)[token](#token)[width](#width)