IDataManager | trueChart Core API

DataManager interface for defining the data source(s)

Hierarchy

IDataManager

Index

Methods

Methods

addCommonTable

addCommonTable(commonTable: IDataCommonTable): string

- Defined in Manager/IDataManager.ts:25
Adds a common table

Parameters
- commonTable: IDataCommonTable
  
  Common table object to be added
Returns string

internal id to the added common table for reference

addDataSource

addDataSource(name?: undefined | string): IDataSource

- Defined in Manager/IDataManager.ts:18
Creates and adds an empty datasource object.

Parameters
- Optional name: undefined | string
  
  Initial name of the datasource. If undefined, a random name will be generated. Can be changed later using the Name property.
Returns IDataSource

The new datasource object.

addDataSourceAsync

addDataSourceAsync(dataSource: IDataSourceAsync): Promise<string>

- Defined in Manager/IDataManager.ts:11
Adds an asynchronous data source

Parameters
- dataSource: IDataSourceAsync
  
  Data source object to be added
Returns Promise<string>

internal id to the added data context for reference

getAllDataSources

getAllDataSources(): IDataModelBaseAsync[]

- Defined in Manager/IDataManager.ts:50
Returns an array with all datasources

Returns IDataModelBaseAsync[]

getCommonTable

getCommonTable(id: string): IDataCommonTable | undefined

- Defined in Manager/IDataManager.ts:44
Gets a previously added common table

Parameters
- id: string
  
  Internal id of the common table
Returns IDataCommonTable | undefined

The common table

removeCommonTable

removeCommonTable(id: string): void

- Defined in Manager/IDataManager.ts:37
Removes a previously added common table

Parameters
- id: string
  
  Internal id of the common table
Returns void

removeDataSource

removeDataSource(id: string): void

- Defined in Manager/IDataManager.ts:31
Removes a previously added datasource

Parameters
- id: string
  
  Internal id of the datasource
Returns void