Class Dashboards

Hierarchy

TagoIOModule<GenericModuleParams>
- Dashboards

Index

Constructors

constructor

Properties

widgets

Methods

Constructors

constructor

new Dashboards(params: GenericModuleParams): Dashboards

Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in src/common/TagoIOModule.ts:79
Parameters
- params: GenericModuleParams
Returns Dashboards

Properties

widgets

widgets: Widgets = ...

Methods

create

create(dashboardObj: DashboardCreateInfo): Promise<{ dashboard: string }>

- Defined in src/modules/Account/Dashboards.ts:52
Generates and retrieves a new dashboard from the account

Parameters
- dashboardObj: DashboardCreateInfo
  
  Object data to create new Dashboard
Returns Promise<{ dashboard: string }>

delete

delete(dashboardID: string): Promise<string>

- Defined in src/modules/Account/Dashboards.ts:85
Deletes an dashboard from the account

Parameters
- dashboardID: string
  
  Dashboard identification
Returns Promise<string>

duplicate

duplicate(dashboardID: string, dashboardObj?: { new_label?: string; setup?: object }): Promise<{ dashboard_id: string; message: string }>

- Defined in src/modules/Account/Dashboards.ts:113
Duplicate the dashboard to your own account

Parameters
- dashboardID: string
  
  Dashboard identification
- Optional dashboardObj: { new_label?: string; setup?: object }
  
  Object with data of the duplicate dashboard
  - Optional new_label?: string
  - Optional setup?: object
Returns Promise<{ dashboard_id: string; message: string }>

edit

edit(dashboardID: string, dashboardObj: Partial<DashboardInfo>): Promise<string>

- Defined in src/modules/Account/Dashboards.ts:69
Modify any property of the action

Parameters
- dashboardID: string
  
  Dashboard identification
- dashboardObj: Partial<DashboardInfo>
  
  Dashboard Object with data to be replaced
Returns Promise<string>

getPublicKey

getPublicKey(dashboardID: string, expireTime?: ExpireTimeOption): Promise<PublicKeyResponse>

- Defined in src/modules/Account/Dashboards.ts:165
Generate a new public token for the dashboard

Parameters
- dashboardID: string
  
  Dashboard identification
- expireTime: ExpireTimeOption = "never"
  
  Time when token will expire
Returns Promise<PublicKeyResponse>

info

info(dashboardID: string): Promise<DashboardInfo>

- Defined in src/modules/Account/Dashboards.ts:98
Gets information about the dashboard

Parameters
- dashboardID: string
  
  Dashboard identification
Returns Promise<DashboardInfo>

list

list(queryObj?: DashboardQuery): Promise<DashboardInfo[]>

- Defined in src/modules/Account/Dashboards.ts:31
Retrieves a list with all dashboards from the account
default
```
queryObj: {
  page: 1,
  fields: ["id", "name"],
  filter: {},
  amount: 20,
  orderBy: "label,asc",
}
```
Parameters
- Optional queryObj: DashboardQuery
  
  Search query params
Returns Promise<DashboardInfo[]>

listAnalysisRelated

listAnalysisRelated(dashboardID: string): Promise<AnalysisRelated[]>

- Defined in src/modules/Account/Dashboards.ts:199
Get list of analysis related with a dashboard

Parameters
- dashboardID: string
  
  Dashboard identification
Returns Promise<AnalysisRelated[]>

listDevicesRelated

listDevicesRelated(dashboardID: string): Promise<DevicesRelated[]>

- Defined in src/modules/Account/Dashboards.ts:186
Get list of devices related with dashboard

Parameters
- dashboardID: string
  
  Dashboard identification
Returns Promise<DevicesRelated[]>

runWidgetHeaderButtonAnalysis

runWidgetHeaderButtonAnalysis(analysisID: string, dashboardID: string, widgetID: string, scope?: object): Promise<string>

- Defined in src/modules/Account/Dashboards.ts:215
Runs an analysis located in a widget's header button

Parameters
- analysisID: string
  
  The id of the analysis to run
- dashboardID: string
  
  The id of the dashboard that contains the widget
- widgetID: string
  
  The id of the widget that contains the header button
- Optional scope: object
  
  Data to send to the analysis
Returns Promise<string>

shareDelete

shareDelete(shareID: string): Promise<string>

- Defined in src/modules/Account/Dashboards.ts:156
Remove share of the bucket

Parameters
- shareID: string
  
  Share identification
Returns Promise<string>

shareEdit

shareEdit(shareID: string, targetObj: Partial<InviteInfo>): Promise<string>

- Defined in src/modules/Account/Dashboards.ts:148
Change permissions of the bucket

Parameters
- shareID: string
  
  Share identification
- targetObj: Partial<InviteInfo>
  
  Object with target email and new permission
Returns Promise<string>

shareList

shareList(dashboardID: string): Promise<InviteInfo[]>

- Defined in src/modules/Account/Dashboards.ts:130
Get share list of the dashboard

Parameters
- dashboardID: string
  
  Dashboard identification
Returns Promise<InviteInfo[]>

shareSendInvite

shareSendInvite(dashboardID: string, inviteObj: InviteInfo): Promise<InviteResponse>

- Defined in src/modules/Account/Dashboards.ts:139
Share the dashboard with another person

Parameters
- dashboardID: string
  
  Dashboard identification
- inviteObj: InviteInfo
  
  Object with target and message
Returns Promise<InviteResponse>