@highcharts/dashboards
Version:
Highcharts Dashboards framework
59 lines (58 loc) • 1.82 kB
TypeScript
import type { DataEventDetail } from '../DataEvent';
import type CSVConnectorOptions from './CSVConnectorOptions';
import CSVConverter from '../Converters/CSVConverter.js';
import DataConnector, { type Event as DataConnectorEvent } from './DataConnector.js';
/**
* Class that handles creating a DataConnector from CSV
*
* @private
*/
declare class CSVConnector extends DataConnector {
protected static readonly defaultOptions: CSVConnectorOptions;
/**
* Constructs an instance of CSVConnector.
*
* @param {Partial<CSVConnectorOptions>} [options]
* Options for the connector and converter.
*/
constructor(options?: Partial<CSVConnectorOptions>);
/**
* Options related to the handling of the CSV DataConnector,
* i.e. source, fetching, polling
*/
readonly options: CSVConnectorOptions;
/**
* The attached parser, which can be replaced in the constructor
*/
converter?: CSVConverter;
/**
* Overrides the DataConnector method. Emits an event on the connector to
* all registered callbacks of this event.
*
* @param {Event} e
* Event object containing additional event information.
*/
emit(e: Event): void;
/**
* Initiates the loading of the CSV source to the connector
*
* @param {DataEventDetail} [eventDetail]
* Custom information for pending events.
*
* @emits CSVConnector#load
* @emits CSVConnector#afterLoad
*/
load(eventDetail?: DataEventDetail): Promise<this>;
}
/**
* Event objects fired from CSVConnector events.
*/
export interface Event extends DataConnectorEvent {
readonly csv?: string;
}
declare module './DataConnectorType' {
interface DataConnectorTypes {
CSV: typeof CSVConnector;
}
}
export default CSVConnector;