Class TaskDataChartApi

Hierarchy (view full)

ChartWithRefreshApi
- TaskDataChartApi

Implements

IUpdateablePropertyDashboardItem

Index

Methods

getProperties isReady refresh updateProperties

Methods

getProperties

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

Returns Promise<TaskDataChartWorkerGet>
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

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: TaskDataChartWorkerUpdate
  Object with new properties to use
Returns Promise<void>
Implementation of IUpdateablePropertyDashboardItem.updateProperties