Class Widgets

Hierarchy

TagoIOModule<GenericModuleParams>
- Widgets

Index

Constructors

constructor

Methods

create delete deleteData edit editData editResource getData info runAnalysis sendData tokenGenerate

Constructors

constructor

new Widgets(params): Widgets
Parameters
- params: GenericModuleParams
Returns Widgets
Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in common/TagoIOModule.ts:79

Methods

create

create(dashboardID, widgetObj): Promise<{
widget: string;
}>
Create a Dashboard Widget
Parameters
- dashboardID: string
  
  Dashboard identification
- widgetObj: WidgetInfo
Returns Promise<{
widget: string;
}>
- Defined in modules/Resources/Dashboard.Widgets.ts:18

delete

delete(dashboardID, widgetID): Promise<string>
Delete the Dashboard Widget
Parameters
- dashboardID: string
  
  Dashboard identification
- widgetID: string
  
  Widget identification
Returns Promise<string>
- Defined in modules/Resources/Dashboard.Widgets.ts:49

deleteData

deleteData(dashboardID, widgetID, ids): Promise<string>
Delete data by it's id, bucket and variable must be associeted with the widget
Parameters
- dashboardID: string
  
  Dashboard identification
- widgetID: string
  
  Widget identification
- ids: string
Returns Promise<string>
- Defined in modules/Resources/Dashboard.Widgets.ts:185

edit

edit(dashboardID, widgetID, data): Promise<string>
Edit the Dashboard Widget
Parameters
- dashboardID: string
  
  Dashboard identification
- widgetID: string
  
  Widget identification
- data: Partial<WidgetInfo>
Returns Promise<string>
- Defined in modules/Resources/Dashboard.Widgets.ts:34

editData

editData(dashboardID, widgetID, data, bypassBucket?): Promise<object>
Update value of variable for the current widget
Parameters
- dashboardID: string
  
  Dashboard identification
- widgetID: string
  
  Widget identification
- data: EditDataModel | EditDataModel[]
- bypassBucket: boolean = false
Returns Promise<object>
- Defined in modules/Resources/Dashboard.Widgets.ts:120

editResource

editResource(dashboardID, widgetID, resourceData, options?): Promise<object>
Update value of a resource for the current widget
Parameters
- dashboardID: string
  
  Dashboard identification
- widgetID: string
  
  Widget identification
- resourceData: EditDeviceResource | EditDeviceResource[]
  
  Updated data for the resource
- Optional options: EditResourceOptions
  
  Additional options
Returns Promise<object>
- Defined in modules/Resources/Dashboard.Widgets.ts:145

getData

getData(dashboardID, widgetID, params?): Promise<object>
Get all data or resource list for the current widget
Parameters
- dashboardID: string
  
  Dashboard identification
- widgetID: string
  
  Widget identification
- Optional params: GetDataModel
Returns Promise<object>
- Defined in modules/Resources/Dashboard.Widgets.ts:78

info

info(dashboardID, widgetID): Promise<WidgetInfo>
Get Info of the Dashboard Widget
Parameters
- dashboardID: string
  
  Dashboard identification
- widgetID: string
  
  Widget identification
Returns Promise<WidgetInfo>
- Defined in modules/Resources/Dashboard.Widgets.ts:63

runAnalysis

runAnalysis(dashboardID, widgetID, data): Promise<object>
Run analysis without inserting data to bucket
Parameters
- dashboardID: string
  
  Dashboard identification
- widgetID: string
  
  Widget identification
- data: [object | Data]
Returns Promise<object>
- Defined in modules/Resources/Dashboard.Widgets.ts:169

sendData

sendData(dashboardID, widgetID, data, bypassBucket?): Promise<object>
Send value of variable for the current widget
Parameters
- dashboardID: string
  
  Dashboard identification
- widgetID: string
  
  Widget identification
- data: PostDataModel | PostDataModel[]
- bypassBucket: boolean = false
Returns Promise<object>
- Defined in modules/Resources/Dashboard.Widgets.ts:95

tokenGenerate

tokenGenerate(dashboardID, widgetID): Promise<{
widget_token: string;
}>
Generate a new token for the embed widgets It can regenerate the token if call it multi-times
Parameters
- dashboardID: string
  
  Dashboard identification
- widgetID: string
  
  Widget identification
Returns Promise<{
widget_token: string;
}>
- Defined in modules/Resources/Dashboard.Widgets.ts:203

Class Widgets

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

params: GenericModuleParams

Returns Widgets

Methods

create

Parameters

dashboardID: string

widgetObj: WidgetInfo

Returns Promise<{ widget: string; }>

delete

Parameters

dashboardID: string

widgetID: string

Returns Promise<string>

deleteData

Parameters

dashboardID: string

widgetID: string

ids: string

Returns Promise<string>

edit

Parameters

dashboardID: string

widgetID: string

data: Partial<WidgetInfo>

Returns Promise<string>

editData

Parameters

dashboardID: string

widgetID: string

data: EditDataModel | EditDataModel[]

bypassBucket: boolean = false

Returns Promise<object>

editResource

Parameters

dashboardID: string

widgetID: string

resourceData: EditDeviceResource | EditDeviceResource[]

Optional options: EditResourceOptions

Returns Promise<object>

getData

Parameters

dashboardID: string

widgetID: string

Optional params: GetDataModel

Returns Promise<object>

info

Parameters

dashboardID: string

widgetID: string

Returns Promise<WidgetInfo>

runAnalysis

Parameters

dashboardID: string

widgetID: string

data: [object | Data]

Returns Promise<object>

sendData

Parameters

dashboardID: string

widgetID: string

data: PostDataModel | PostDataModel[]

bypassBucket: boolean = false

Returns Promise<object>

tokenGenerate

Parameters

dashboardID: string

widgetID: string

Returns Promise<{ widget_token: string; }>

Settings

Member Visibility

Theme

On This Page

Returns Promise<{
widget: string;
}>

`Optional` options: EditResourceOptions

`Optional` params: GetDataModel

Returns Promise<{
widget_token: string;
}>