Interface Dashboard

Details of a dashboard.

interface Dashboard {
    automaticRefreshMs?: number;
    description?: string;
    editPermissions?: Version3.Version3Models.SharePermission[];
    id: string;
    isFavourite?: boolean;
    isWritable?: boolean;
    name?: string;
    owner?: Version3.Version3Models.DashboardUser;
    popularity?: number;
    rank?: number;
    self?: string;
    sharePermissions?: Version3.Version3Models.SharePermission[];
    systemDashboard?: boolean;
    view?: string;
}

Properties

automaticRefreshMs? description? editPermissions? id isFavourite? isWritable? name? owner? popularity? rank? self? sharePermissions? systemDashboard? view?

Properties

Optional automaticRefreshMs

automaticRefreshMs?: number

The automatic refresh interval for the dashboard in milliseconds.

Optional description

description?: string

Optional editPermissions

editPermissions?: Version3.Version3Models.SharePermission[]

The details of any edit share permissions for the dashboard.

id

id: string

The ID of the dashboard.

Optional isFavourite

isFavourite?: boolean

Whether the dashboard is selected as a favorite by the user.

Optional isWritable

isWritable?: boolean

Whether the current user has permission to edit the dashboard.

Optional name

name?: string

The name of the dashboard.

Optional owner

owner?: Version3.Version3Models.DashboardUser

Optional popularity

popularity?: number

The number of users who have this dashboard as a favorite.

Optional rank

rank?: number

The rank of this dashboard.

Optional self

self?: string

The URL of these dashboard details.

Optional sharePermissions

sharePermissions?: Version3.Version3Models.SharePermission[]

The details of any view share permissions for the dashboard.

Optional systemDashboard

systemDashboard?: boolean

Whether the current dashboard is system dashboard.

Optional view

view?: string

The URL of the dashboard.

Settings

Member Visibility

Theme

On This Page

automaticRefreshMsdescriptioneditPermissionsidisFavouriteisWritablenameownerpopularityrankselfsharePermissionssystemDashboardview