Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Widgets

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

create

  • create(dashboardID: string, widgetObj: WidgetInfo): Promise<{ widget: string }>

delete

  • delete(dashboardID: string, widgetID: string): Promise<string>

deleteData

  • deleteData(dashboardID: string, widgetID: string, ids: string): 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>

edit

  • edit(dashboardID: string, widgetID: string, data: Partial<WidgetInfo>): Promise<string>

editData

editResource

getData

  • getData(dashboardID: string, widgetID: string, params?: GetDataModel): Promise<object>

info

  • info(dashboardID: string, widgetID: string): Promise<WidgetInfo>

runAnalysis

  • runAnalysis(dashboardID: string, widgetID: string, data: [object | 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>

sendData

tokenGenerate

  • tokenGenerate(dashboardID: string, widgetID: string): 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 }>