---
schema_version: "1"
id: 264dc830cff9902cb09be7cd9043d6ac3e695bef9ecca406cb69c856fd36498d
title: DashboardObject | 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/DashboardObject.md
canonical_url: https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/DashboardObject.html
source_site: help.tableau.com
content_type: documentation
content_hash: 8aec67944e09675af5dd5b1fd52570069d52ce313ddcc357bef6c507f944984d
description: Documentation for Tableau Embedding API
---
- DashboardObject

# Interface DashboardObject

An object of a dashboard.

interface DashboardObject {  
    [dashboard](#dashboard): [Dashboard](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Dashboard.html);  
    [id](#id): number;  
    [isFloating](#isfloating): boolean;  
    [isVisible](#isvisible): boolean;  
    [name](#name): string;  
    [position](#position): [Point](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Point.html);  
    [size](#size): [Size](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Size.html);  
    [type](#type): [DashboardObjectType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/DashboardObjectType.html);  
    [worksheet](#worksheet): undefined | [Worksheet](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Worksheet.html);  
}

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:700

##### Index

### Properties

[dashboard](#dashboard) [id](#id) [isFloating](#isfloating) [isVisible](#isvisible) [name](#name) [position](#position) [size](#size) [type](#type) [worksheet](#worksheet)

## Properties

### `Readonly`dashboard[](#dashboard)

dashboard: [Dashboard](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Dashboard.html)

#### Returns[](#returns)

The Dashboard object that contains this object.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:704

### `Readonly`id[](#id)

id: number

#### Returns[](#returns-1)

The id of the dashboard object

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:744

### `Readonly`isFloating[](#isfloating)

isFloating: boolean

#### Returns[](#returns-2)

True if the object is floating in the dashboard.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:734

### `Readonly`isVisible[](#isvisible)

isVisible: boolean

#### Returns[](#returns-3)

True if the object is visible.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:739

### `Readonly`name[](#name)

name: string

#### Returns[](#returns-4)

The name of the dashboard object. This is the name given to the object during authoring.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:729

### `Readonly`position[](#position)

position: [Point](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Point.html)

#### Returns[](#returns-5)

The coordinates relative to the top-left corner of the dashboard containing this object.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:714

### `Readonly`size[](#size)

size: [Size](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Size.html)

#### Returns[](#returns-6)

The size of the object.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:719

### `Readonly`type[](#type)

type: [DashboardObjectType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/DashboardObjectType.html)

#### Returns[](#returns-7)

What the object represents.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:709

### `Readonly`worksheet[](#worksheet)

worksheet: undefined | [Worksheet](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Worksheet.html)

#### Returns[](#returns-8)

If type returns WORKSHEET, this returns a Worksheet object, undefined otherwise.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:724

### Settings

Member Visibility

- Protected
- Inherited
- External

ThemeOSLightDark

### On This Page

Properties

[dashboard](#dashboard)[id](#id)[isFloating](#isfloating)[isVisible](#isvisible)[name](#name)[position](#position)[size](#size)[type](#type)[worksheet](#worksheet)