Interface Dashboard

Details of a dashboard.

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

Properties

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

Properties

OptionalautomaticRefreshMs

automaticRefreshMs?: number

The automatic refresh interval for the dashboard in milliseconds.

Optionaldescription

description?: string

OptionaleditPermissions

editPermissions?: SharePermission[]

The details of any edit share permissions for the dashboard.

Optionalid

id?: string

The ID of the dashboard.

OptionalisFavourite

isFavourite?: boolean

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

OptionalisWritable

isWritable?: boolean

Whether the current user has permission to edit the dashboard.

Optionalname

name?: string

The name of the dashboard.

Optionalowner

owner?: UserBean

The owner of the dashboard.

Optionalpopularity

popularity?: number

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

Optionalrank

rank?: number

The rank of this dashboard.

Optionalself

self?: string

The URL of these dashboard details.

OptionalsharePermissions

sharePermissions?: SharePermission[]

The details of any view share permissions for the dashboard.

OptionalsystemDashboard

systemDashboard?: boolean

Whether the current dashboard is system dashboard.

Optionalview

view?: string

The URL of the dashboard.

Settings

Member Visibility

On This Page

Properties