Class DataPool

Data pool to load connectors on-demand.

Name

Data.DataPool

Param: options

Pool options with all connectors.

Implements

DataEventEmitter<Event>

Index

Constructors

Properties

connectors options waiting defaultOptions

Methods

cancelPendingRequests emit getConnector isNewConnector on setConnectorOptions

Constructors

constructor

new DataPool(options?: DataPoolOptions): DataPool
Parameters
- Optionaloptions: DataPoolOptions
Returns DataPool

Properties

`Protected` `Readonly`connectors

connectors: Record<string, DataConnectorType>

Internal dictionary with the connectors and their IDs.

`Readonly`options

options: DataPoolOptions

Pool options with all connectors.

`Protected` `Readonly`waiting

waiting: Record<string, [Function, Function][]>

Internal dictionary with the promise resolves waiting for connectors to be done loading.

`Protected` `Static` `Readonly`defaultOptions

defaultOptions: DataPoolOptions = ...

Methods

cancelPendingRequests

cancelPendingRequests(): void
Cancels all data connectors pending requests.

Returns void

emit

emit(e: Event): void
Emits an event on this data pool to all registered callbacks of the given event.
Parameters
- e: Event
  Event object with event information.
Returns void
Implementation of DataEventEmitter.emit

getConnector

getConnector(
    connectorId: string,
): Promise<
    | CSVConnector
    | GoogleSheetsConnector
    | HTMLTableConnector
    | JSONConnector,
>
Function
Loads the connector.

Data.DataPool#getConnector
Parameters
- connectorId: string
  ID of the connector.
Returns Promise<
    | CSVConnector
    | GoogleSheetsConnector
    | HTMLTableConnector
    | JSONConnector,
>
Returns the connector.

isNewConnector

isNewConnector(connectorId: string): boolean
Tests whether the connector has never been requested.
Parameters
- connectorId: string
  Name of the connector.
Returns boolean
Returns true, if the connector has never been requested, otherwise false.

on

on<
    T extends
        | "load"
        | "afterLoad"
        | "setConnectorOptions"
        | "afterSetConnectorOptions",
>(
    type: T,
    callback: DataEventCallback<DataPool, Extract<Event, { type: T }>>,
): Function
Function
Registers a callback for a specific event.

Highcharts.DataPool#on
Type Parameters
- T extends "load" | "afterLoad" | "setConnectorOptions" | "afterSetConnectorOptions"
Parameters
- type: T
  Event type as a string.
- callback: DataEventCallback<DataPool, Extract<Event, { type: T }>>
  Function to register for an event callback.
Returns Function
Function to unregister callback from the event.

Implementation of DataEventEmitter.on

setConnectorOptions

setConnectorOptions(
    options:
        | CSVConnectorOptions
        | GoogleSheetsConnectorOptions
        | HTMLTableConnectorOptions
        | JSONConnectorOptions,
    update?: boolean,
): void
Parameters
- options:
      | CSVConnectorOptions
      | GoogleSheetsConnectorOptions
      | HTMLTableConnectorOptions
      | JSONConnectorOptions
- Optionalupdate: boolean
Returns void
setConnectorOptions(
    options:
        | CSVConnectorOptions
        | GoogleSheetsConnectorOptions
        | HTMLTableConnectorOptions
        | JSONConnectorOptions,
    update: true,
): Promise<void>
Parameters
- options:
      | CSVConnectorOptions
      | GoogleSheetsConnectorOptions
      | HTMLTableConnectorOptions
      | JSONConnectorOptions
- update: true
Returns Promise<void>