Class Widgets

Hierarchy

Constructors

constructor

Methods

create delete deleteData edit editData editResource getData info runAnalysis sendData tokenGenerate

Constructors

constructor

Methods

create

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

  • Create a Dashboard Widget

    Parameters

    • dashboardID: string

      Dashboard identification

    • widgetObj: WidgetInfo

    Returns Promise<{
        widget: string;
    }>

delete

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

  • Delete the Dashboard Widget

    Parameters

    • dashboardID: string

      Dashboard identification

    • widgetID: string

      Widget identification

    Returns Promise<string>

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>

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>

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>

editResource

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>

info

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>

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>

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;
    }>

Settings

Member Visibility

Theme

On This Page

constructorcreatedeletedeleteDataediteditDataeditResourcegetDatainforunAnalysissendDatatokenGenerate