Class Dashboards

Hierarchy

Index

Constructors

constructor

Properties

widgets

widgets: Widgets = new Widgets(this.params)

Methods

create

delete

  • delete(dashboardID: GenericID): Promise<string>

duplicate

  • duplicate(dashboardID: GenericID, dashboardObj?: { new_label?: string; setup?: object }): Promise<{ dashboard_id: string; message: string }>
  • Duplicate the dashboard to your own account

    Parameters

    • dashboardID: GenericID

      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

getPublicKey

info

list

  • Retrieves a list with all dashboards from the account

    default
    queryObj: {
      page: 1,
      fields: ["id", "name"],
      filter: {},
      amount: 20,
      orderBy: "label,asc",
    }

    Parameters

    Returns Promise<DashboardInfo[]>

listDevicesRelated

runWidgetHeaderButtonAnalysis

  • Runs an analysis located in a widget's header button

    Parameters

    • analysisID: GenericID

      The id of the analysis to run

    • dashboardID: GenericID

      The id of the dashboard that contains the widget

    • widgetID: GenericID

      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: GenericID): Promise<string>

shareEdit

shareList

shareSendInvite