Interface
Interface for map related data sources. It contains a JS API Map instance.
Properties
Property | Type | Notes |
---|---|---|
() => Promise<DataSource[]> | All child data sources (including descendant data sources) are ready for use.
Data source has this method only if it is data source set ( | |
(dataSourceId: string) => Promise<DataSource> | Create a child or a descendant data source by id.
Data source has this method only if it is data source set ( | |
() => Promise<IMDataSourceSchema> | Fetch the data schema from an actual data source. If it's a statistic data source, the schema will not be fetched. | |
() => Promise<void> | Ready is resolved means the data source instance is ready for use.
Please note that can not make sure all child data sources are created if a set data source is ready.
To make sure all child data sources are created, please use | |
The type of the data source. |
childDataSourcesReady
Interface PropertychildDataSourcesReady: () => Promise<DataSource[]>
All child data sources (including descendant data sources) are ready for use.
Data source has this method only if it is data source set ( dataSource.isDataSourceSet()
is true).
Type declaration
function(): Promise<DataSource[]>
Returns
Promise<DataSource[]>
createDataSourceById
Interface PropertycreateDataSourceById: (dataSourceId: string) => Promise<DataSource>
Create a child or a descendant data source by id.
Data source has this method only if it is data source set ( dataSource.isDataSourceSet()
is true).
Please note will only create the specific data source, won't create descendant data sources of it.
Type declaration
function(dataSourceId: string): Promise<DataSource>
Parameters
Parameter | Type |
---|---|
data | string |
Returns
Promise<DataSource>
fetchSchema
Interface PropertyfetchSchema: () => Promise<IMDataSourceSchema>
Fetch the data schema from an actual data source. If it's a statistic data source, the schema will not be fetched.
Type declaration
function(): Promise<IMDataSourceSchema>
Returns
Promise<IMDataSourceSchema>
ready
Interface Propertyready: () => Promise<void>
Ready is resolved means the data source instance is ready for use.
Please note that can not make sure all child data sources are created if a set data source is ready.
To make sure all child data sources are created, please use childDataSourcesReady
.
Type declaration
function(): Promise<void>
Returns
Promise<void>
type
Interface Propertytype: DataSourceTypes
The type of the data source.