Class RetrievalApi

Index

Methods

alsoRetrieveWhenRefreshed getProperties onBeforeRetrieval refresh updateProperties

Methods

alsoRetrieveWhenRefreshed

alsoRetrieveWhenRefreshed(settings): Promise<AlsoRetrieveApi>
Allows fetching additional data when this retrieval is refreshed without requiring a chart.
Parameters
- settings: ChartWorkerRetrievalSettings[]
  A list of Retrieval Settings
Returns Promise<AlsoRetrieveApi>
A list retrieval API. Bind to onRetrieved in order to use the fetched data.

getProperties

getProperties(): Promise<RetrievalWorkerGet>
Gets the retrieval's properties

Returns Promise<RetrievalWorkerGet>

onBeforeRetrieval

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.
Parameters
- fn: ((event: RetrievalBeforeScriptEvent) => void)
  The function to fire.
  - - (event): void
    - Parameters
      event: RetrievalBeforeScriptEvent
      Returns void
Returns ScriptEventSubscription
ScriptEventSubscription

refresh

refresh(): Promise<void>
Refreshes the entire retrieval.

Returns Promise<void>

updateProperties

updateProperties(newProps): Promise<void>
Updates the retrieval with new values.
Parameters
- newProps: RetrievalWorkerUpdate
  Object with new properties to use
Returns Promise<void>