Class ScriptedChartApi

Hierarchy (view full)

ChartApi
- ScriptedChartApi

Implements

IUpdateablePropertyDashboardItem

Index

Methods

addLoading draw getProperties isReady onClick removeLoading updateProperties

Methods

addLoading

addLoading(): Promise<void>
Adds a loading overlay to the chart.

Returns Promise<void>

draw

draw(data): Promise<void>
Draws the chart with the given plotly data.
Parameters
- data: GraphData[]
  The plotly (https://plotly.com/javascript/reference/) data to draw.
Returns Promise<void>

getProperties

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

Returns Promise<DashboardItemWorkerGet>
Implementation of IUpdateablePropertyDashboardItem.getProperties

isReady

isReady(): Promise<void>
Returns a promise which resolves when the chart is ready to be interacted with.
If the chart is currently loading, this promise will resolve when it has finished.

Returns Promise<void>
Inherited from ChartApi.isReady

onClick

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

removeLoading

removeLoading(): Promise<void>
Removes a loading overlay from the chart.

Returns Promise<void>

updateProperties

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