DashboardObject | Tableau Embedding API

Interface DashboardObject

An object of a dashboard.

interface DashboardObject {
    dashboard: Dashboard;
    id: number;
    isFloating: boolean;
    isVisible: boolean;
    name: string;
    position: Point;
    size: Size;
    type: DashboardObjectType;
    worksheet: undefined | Worksheet;
}
Index

Properties

dashboard: Dashboard

The Dashboard object that contains this object.

id: number

The id of the dashboard object

isFloating: boolean

True if the object is floating in the dashboard.

isVisible: boolean

True if the object is visible.

name: string

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

position: Point

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

size: Size

The size of the object.

What the object represents.

worksheet: undefined | Worksheet

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