Interface Dashboard

Model of a Dashboard.

interface Dashboard {
    _links?: any;
    dashboardScope?: DashboardScope;
    description?: string;
    eTag?: string;
    globalParametersConfig?: string;
    groupId?: string;
    id?: string;
    lastAccessedDate?: Date;
    modifiedBy?: string;
    modifiedDate?: Date;
    name?: string;
    ownerId?: string;
    position?: number;
    refreshInterval?: number;
    url?: string;
    widgets?: Widget[];
}

Hierarchy (View Summary)

Properties

_links? dashboardScope? description? eTag? globalParametersConfig? groupId? id? lastAccessedDate? modifiedBy? modifiedDate? name? ownerId? position? refreshInterval? url? widgets?

Properties

Optional_links

_links?: any

OptionaldashboardScope

dashboardScope?: DashboardScope

Entity to which the dashboard is scoped.

Optionaldescription

description?: string

Description of the dashboard.

OptionaleTag

eTag?: string

Server defined version tracking value, used for edit collision detection.

OptionalglobalParametersConfig

globalParametersConfig?: string

Dashboard Global Parameters Config

OptionalgroupId

groupId?: string

ID of the group for a dashboard. For team-scoped dashboards, this is the unique identifier for the team associated with the dashboard. For project-scoped dashboards this property is empty.

Optionalid

id?: string

ID of the Dashboard. Provided by service at creation time.

OptionallastAccessedDate

lastAccessedDate?: Date

Dashboard Last Accessed Date.

OptionalmodifiedBy

modifiedBy?: string

Id of the person who modified Dashboard.

OptionalmodifiedDate

modifiedDate?: Date

Dashboard's last modified date.

Optionalname

name?: string

Name of the Dashboard.

OptionalownerId

ownerId?: string

ID of the owner for a dashboard. For team-scoped dashboards, this is the unique identifier for the team associated with the dashboard. For project-scoped dashboards, this is the unique identifier for the user identity associated with the dashboard.

Optionalposition

position?: number

Position of the dashboard, within a dashboard group. If unset at creation time, position is decided by the service.

OptionalrefreshInterval

refreshInterval?: number

Interval for client to automatically refresh the dashboard. Expressed in minutes.

Optionalurl

url?: string

Optionalwidgets

widgets?: Widget[]

The set of Widgets on the dashboard.

Settings

Member Visibility

On This Page

Properties