Scripting API / dashboard/retrievals/RetrievalApi

dashboard/retrievals/RetrievalApi

Modules

Module	Description
External	-

alsoRetrieveWhenRefreshed(settings): Promise<AlsoRetrieveApi>

Allows fetching additional data when this retrieval is refreshed without requiring a chart.

Parameter	Type	Description
`settings`	`ChartWorkerRetrievalSettings`[]	A list of Retrieval Settings

A list retrieval API. Bind to onRetrieved in order to use the fetched data.

getProperties(): Promise<RetrievalWorkerGet>

Gets the retrieval's properties

onBeforeRetrieval(fn): ScriptEventSubscription

Bind a function to fire before a retrieval fetches data. preventDefault can be called on the event to prevent the retrieval from fetching data.

Parameter	Type	Description
`fn`	(`event`) => `void`	The function to fire.

ScriptEventSubscription

refresh(): Promise<void>

Refreshes the entire retrieval.

Promise<void>

updateProperties(newProps): Promise<void>

Updates the retrieval with new values.

Parameter	Type	Description
`newProps`	`RetrievalWorkerUpdate`	Object with new properties to use

Promise<void>