Class ButtonDashboardItemApi

Hierarchy (view full)

DashboardItemApi
- ButtonDashboardItemApi

Implements

IUpdateablePropertyDashboardItem

Index

Methods

getProperties onClick updateProperties

Methods

getProperties

getProperties(): Promise<ButtonDashboardItemWorkerGet>
Gets the dashboard item's properties

Returns Promise<ButtonDashboardItemWorkerGet>
Implementation of IUpdateablePropertyDashboardItem.getProperties

onClick

onClick(fn): ScriptEventSubscription
Bind a function to fire when the button is clicked.
Parameters
- fn: ((event: ScriptEvent) => void)
  The function to fire.
  - - (event): void
    - Parameters
      event: ScriptEvent
      Returns void
Returns ScriptEventSubscription
ScriptEventSubscription

updateProperties

updateProperties(newProps): Promise<void>
Updates the dashboard item with new values.
Parameters
- newProps: ButtonDashboardItemWorkerUpdate
  Object with new properties to use
Returns Promise<void>
Implementation of IUpdateablePropertyDashboardItem.updateProperties