Class ParetoChartApi

Hierarchy (view full)

ChartWithRefreshApi
- ParetoChartApi

Implements

Index

Methods

getProperties isReady onBeforeDraw refresh updateProperties

Methods

getProperties

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

Returns Promise<ParetoChartWorkerGet>
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 ChartWithRefreshApi.isReady

onBeforeDraw

onBeforeDraw(fn): ScriptEventSubscription
Bind a function to fire before the chart draws with new data.

Any changes to event.data.plotlyData will be reflected in the drawn chart.

Changing any of the plots in event.data.plotlyData will cause the click events to no longer fire on this chart.
Parameters
- fn: ((event: ParetoChartBeforeDrawScriptEvent) => void)
  The function to fire.
  - - (event): void
    - Parameters
      event: ParetoChartBeforeDrawScriptEvent
      Returns void
Returns ScriptEventSubscription
ScriptEventSubscription

Implementation of IBeforeDrawableChart.onBeforeDraw

refresh

refresh(): Promise<void>
Refreshes this chart without retrieving data for the rest of the retrieval.
When called, onBeforeRetrieval will only contain data for this chart.

Returns Promise<void>
Inherited from ChartWithRefreshApi.refresh

updateProperties

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