--- schema_version: "1" id: 3a5ac3f712820077f3f8669949c73f75695a7ab444fa9e1633a79e364b5c762a title: Dashboard | Tableau Embedding API collection: tableau version: next locale: en-us portal_url: https://docs.salesforce.com/tableau/next/en-us/api/embedding_api/reference/interfaces/Dashboard.md canonical_url: https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Dashboard.html source_site: help.tableau.com content_type: documentation content_hash: e8c796d1c4752d7148935b49db95f72d01d329470d5244cfc7a2a6c27e040f08 description: Documentation for Tableau Embedding API --- - Dashboard # Interface Dashboard interface Dashboard {     [index](#index): number;     [isActive](#isactive): boolean;     [isHidden](#ishidden): boolean;     [name](#name): string;     [objects](#objects): [DashboardObject](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/DashboardObject.html)\[\];     [parentStoryPoint](#parentstorypoint): null | [StoryPoint](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPoint.html);     [sheetType](#sheettype): [SheetType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/SheetType.html);     [size](#size): [SheetSize](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/SheetSize.html);     [url](#url): string;     [workbook](#workbook): [Workbook](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Workbook.html);     [worksheets](#worksheets): [Worksheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Worksheet.html)\[\];     [applyFilterAsync](#applyfilterasync-1)(         fieldName: string,         values: string\[\],         updateType: [FilterUpdateType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/FilterUpdateType.html),         filterOptions: [FilterOptions](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/FilterOptions.html),     ): Promise;     [changeSizeAsync](#changesizeasync-1)(sheetSize: [SheetSize](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/SheetSize.html)): Promise<[SheetSize](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/SheetSize.html)\>;     [getFiltersAsync](#getfiltersasync-1)(): Promise<[Filter](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Filter.html)\[\]\>; } #### Hierarchy ([View Summary](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/hierarchy.html#Dashboard)) - [Sheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html) - Dashboard - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:638 ##### Index ### Methods [applyFilterAsync](#applyfilterasync) [changeSizeAsync](#changesizeasync) [getFiltersAsync](#getfiltersasync) ### Properties [index](#index) [isActive](#isactive) [isHidden](#ishidden) [name](#name) [objects](#objects) [parentStoryPoint](#parentstorypoint) [sheetType](#sheettype) [size](#size) [url](#url) [workbook](#workbook) [worksheets](#worksheets) ## Methods ### applyFilterAsync[](#applyfilterasync) - applyFilterAsync(     fieldName: string,     values: string\[\],     updateType: [FilterUpdateType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/FilterUpdateType.html),     filterOptions: [FilterOptions](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/FilterOptions.html), ): Promise[](#applyfilterasync-1) Applies a simple categorical filter (non-date) to the dashboard. This method is similar to the method used for worksheets, but applies the filter to all the worksheets in the dashboard that have that same field. Note that the filter is ignored by a worksheet if the worksheet doesn't have the relevant field in its data source. #### Parameters - fieldName: string The name of the field to filter on. - values: string\[\] The list of values to filter on. - updateType: [FilterUpdateType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/FilterUpdateType.html) The update type of this filter (add, all, remove, replace). - filterOptions: [FilterOptions](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/FilterOptions.html) Advanced filter options (isExcludeMode). #### Returns Promise The field name that the filter is applied on. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:694 ### changeSizeAsync[](#changesizeasync) - changeSizeAsync(sheetSize: [SheetSize](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/SheetSize.html)): Promise<[SheetSize](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/SheetSize.html)\>[](#changesizeasync-1) Sets the size information of a sheet. Note that if the sheet is a Worksheet, only SheetSizeBehavior.Automatic is allowed since you can't actually set a Worksheet to a fixed size. #### Parameters - sheetSize: [SheetSize](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/SheetSize.html) #### Returns Promise<[SheetSize](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/SheetSize.html)\> Inherited from [Sheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html).[changeSizeAsync](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html#changesizeasync) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:79 ### getFiltersAsync[](#getfiltersasync) - getFiltersAsync(): Promise<[Filter](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Filter.html)\[\]\>[](#getfiltersasync-1) #### Returns Promise<[Filter](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Filter.html)\[\]\> The collection of filters used on the dashboard - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:680 ## Properties ### `Readonly`index[](#index) index: number #### Returns[](#returns) The index of the sheet within the published tabs. Note that hidden tabs are still counted in the ordering, as long as they are published. Inherited from [Sheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html).[index](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html#index) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:58 ### `Readonly`isActive[](#isactive) isActive: boolean #### Returns[](#returns-1) A value indicating whether the sheet is the currently active sheet. Inherited from [Sheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html).[isActive](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html#isactive) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:45 ### `Readonly`isHidden[](#ishidden) isHidden: boolean #### Returns[](#returns-2) A value indicating whether the sheet is hidden (true) or visible (false) in the UI. Note that if the entire tab control is hidden, it does not affect the state of this flag. This sheet may still report that it is visible even when the tabs control is hidden. Inherited from [Sheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html).[isHidden](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html#ishidden) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:52 ### `Readonly`name[](#name) name: string #### Returns[](#returns-3) The name of the sheet. Inherited from [Sheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html).[name](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html#name) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:35 ### `Readonly`objects[](#objects) objects: [DashboardObject](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/DashboardObject.html)\[\] #### Returns[](#returns-4) The collection of objects contained in the dashboard. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:643 ### `Readonly`parentStoryPoint[](#parentstorypoint) parentStoryPoint: null | [StoryPoint](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPoint.html) #### Returns[](#returns-5) Returns the [StoryPoint](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPoint.html) object to which this Dashboard belongs. If the Dashboard doesn't belong to a story, it returns null. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:675 ### `Readonly`sheetType[](#sheettype) sheetType: [SheetType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/SheetType.html) #### Returns[](#returns-6) The type of the sheet. Inherited from [Sheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html).[sheetType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html#sheettype) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:40 ### `Readonly`size[](#size) size: [SheetSize](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/SheetSize.html) #### Returns[](#returns-7) The size information that the author specified when publishing the workbook. Inherited from [Sheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html).[size](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html#size) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:68 ### `Readonly`url[](#url) url: string #### Returns[](#returns-8) the URL for this sheet. Inherited from [Sheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html).[url](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html#url) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:63 ### `Readonly`workbook[](#workbook) workbook: [Workbook](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Workbook.html) #### Returns[](#returns-9) The workbook containing this sheet Inherited from [Sheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html).[workbook](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html#workbook) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:73 ### `Readonly`worksheets[](#worksheets) worksheets: [Worksheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Worksheet.html)\[\] This is a helper method and is equivalent to looping through all of the objects in a dashboard and collecting all of the objects whose type is `worksheet`. You can use this property to iterate through all of the worksheets in the dashboard. #### Returns[](#returns-10) The collection of worksheets contained in the dashboard. The following example uses the JavaScript `forEach()` method to traverse the worksheets in the dashboard. ``` let vizActiveSheet = viz.workbook.activeSheet;if (vizActiveSheet.sheetType === "dashboard") { vizActiveSheet.worksheets.forEach(function (worksheet) { // do something with the worksheets.. })} ``` - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:670 ### Settings Member Visibility - Protected - Inherited - External ThemeOSLightDark ### On This Page Methods [applyFilterAsync](#applyfilterasync)[changeSizeAsync](#changesizeasync)[getFiltersAsync](#getfiltersasync) Properties [index](#index)[isActive](#isactive)[isHidden](#ishidden)[name](#name)[objects](#objects)[parentStoryPoint](#parentstorypoint)[sheetType](#sheettype)[size](#size)[url](#url)[workbook](#workbook)[worksheets](#worksheets)