Tableau Extensions API
    Preparing search index...

    Interface DashboardObject

    An object of a dashboard.

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

    Properties

    dashboard fieldId id isFloating isVisible name position size type worksheet

    Properties

    dashboard: Dashboard

    The Dashboard object that contains this object.

    fieldId: undefined | string

    The field id of the dashboard object if it is a QuickFilter

    id: number

    The id of the dashboard object

    1.1.0

    isFloating: boolean

    True if the object is floating in the dashboard.

    1.1.0

    isVisible: boolean

    True if the object is visible.

    1.1.0

    name: string

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

    1.1.0

    position: Point

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

    size: Size

    The size of the object.

    type: DashboardObjectType

    What the object represents.

    worksheet: undefined | Worksheet

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

    Settings

    Member Visibility

    On This Page

    Properties