DataSource
Interface
The interface for all data sources.
Conceptually, we have four types of data sources but all of them are created as data source object:
- Main data source: the data source user added in data panel.
- Data view: the data view user created in data panel.
- Local data source: when multiple widgets connnect to a main data source or a data view, they'll share the same data records. If you need to
use a local data copy, you can create a local data source from a main data source by using
DataSourceManager.getInstance().createLocalDataSource(). - Local data view: a local data source created from a data view.
Data view, local data source or local data view derived from the same main data source will share the same schema, same selection records, but may have different data records. The schema is in main data source only.
To share the selection between data source and view, we create a selection data view when creating the data source. The selection data source view ID is: ${dataSourceId}-selection .
When selecting records, the selected records are copied to the selection data view.
Properties
| Property | Type | Notes |
|---|---|---|
() => void | ||
() => void | ||
() => boolean | ||
The data source which this data source derives from. | ||
(data: any) => DataRecord | ||
() => Promise<DataSource[]> | ||
() => void | ||
() => void | ||
number | The total records count depends on the current query | |
(dataSourceId: string) => Promise<DataSource> | ||
string | The data view ID configured in Json. | |
() => Promise<IMDataSourceSchema> | ||
() => DataSource[] | ||
() => DataSource[] | ||
(jimuChildId: string) => DataSource | ||
() => DataSource[] | ||
() => DataSourceStatus | ||
() => IMDataSourceJson | ||
(dataViewId: string) => DataSource | ||
() => DataSource[] | ||
() => string | ||
() => IMDataSourceInfo | ||
() => string | ||
() => boolean | ||
(localId: string) => DataSource | ||
() => DataSource[] | ||
() => DataSource | ||
(index: number) => DataRecord | ||
(id: string) => DataRecord | ||
() => DataRecord[] | ||
() => DataRecord[] | ||
() => DataSource | ||
() => IMDataSourceSchema | ||
() => string[] | ||
() => number[] | ||
() => DataRecord[] | ||
() => DataRecord[] | ||
() => number | ||
() => DataSourceStatus | ||
() => number | ||
string | The data source ID. | |
boolean | Whether a data source contains child data sources.
A dataset data source should create all its child data sources before | |
boolean | True means the data source is a data view. For local data source, this is false even the local data source is created from a data view. | |
() => boolean | ||
boolean | True means the data source is a local data source. | |
string | The local ID of the data source. | |
number | Order in the parent data source. | |
The parent data source of this data source, mull means it's a root data source. | ||
() => Promise<any> | ||
(id: string, record?: DataRecord, forceCheck?: boolean) => void | ||
(ids: string[], records?: DataRecord[], forceCheck?: boolean) => void | ||
(status: DataSourceStatus) => void | ||
(dsJson: IMDataSourceJson) => void | ||
(listen: boolean) => void | ||
(records: DataRecord[]) => void | ||
(records: DataRecord[]) => void | ||
(status: DataSourceStatus) => void | ||
string | The type of the data source | |
(ids: string[], triggerDataSource: DataSource, forceCheck?: boolean) => void |
addVersion
addVersion: () => voidType declaration
function(): voidUpdate data source version.
Returns
voidareChildDataSourcesCreated
areChildDataSourcesCreated: () => booleanType declaration
function(): booleanReturn whether all child data sources (including descendant data sources) are created.
Data source has this method only if it is data source set ( dataSource.isDataSourceSet is true).
Returns
booleanbelongToDataSource
belongToDataSource: DataSourceThe data source which this data source derives from.
buildRecord
Interface PropertybuildRecord: (data: any) => DataRecordType declaration
function(data: any): DataRecordBuilds a data record only -- does not add the record into data source.
Parameters
| Parameter | Type |
|---|---|
data | any |
Returns
DataRecordchildDataSourcesReady
childDataSourcesReady: () => Promise<DataSource[]>Type declaration
function(): 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).
Returns
Promise<DataSource[]>clearRecords
clearRecords: () => voidType declaration
function(): voidThis function will clear the loaded records and won't clear the sourceRecords. Once the loaded records are cleared, the version in the data source info will be updated.
Returns
voidclearSourceRecords
Interface PropertyclearSourceRecords: () => voidType declaration
function(): voidClear both sourceRecords and loaded records. Both source version and version in data source info will be updated.
Returns
voidcreateDataSourceById
createDataSourceById: (dataSourceId: string) => Promise<DataSource>Type declaration
function(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.
Parameters
| Parameter | Type |
|---|---|
data | string |
Returns
Promise<DataSource>fetchSchema
Interface PropertyfetchSchema: () => Promise<IMDataSourceSchema>Type declaration
function(): Promise<IMDataSourceSchema>Fetch the data schema from an actual data source. If it's a statistic data source, the schema will not be fetched.
Returns
Promise<IMDataSourceSchema>getAllChildDataSources
getAllChildDataSources: () => DataSource[]Type declaration
function(): DataSource[]Return all child data sources of a parent data source, includes the grandchildren
Returns
DataSource[]getAllDerivedDataSources
Interface PropertygetAllDerivedDataSources: () => DataSource[]Type declaration
function(): DataSource[]Return the derived data views and local data sources.
Returns
DataSource[]getChildDataSource
getChildDataSource: (jimuChildId: string) => DataSourceType declaration
function(jimuChildId: string): DataSourceGet child data source by jimuChildId . You can get jimuChildId by getJimuChildId() .
Parameters
| Parameter | Type |
|---|---|
jimu | string |
Returns
DataSourcegetChildDataSources
getChildDataSources: () => DataSource[]Type declaration
function(): DataSource[]Return child data sources of a parent data source.
Returns
DataSource[]getCountStatus
Interface PropertygetCountStatus: () => DataSourceStatusType declaration
function(): DataSourceStatusReturn data source count status.
Returns
DataSourceStatusgetDataSourceJson
Interface PropertygetDataSourceJson: () => IMDataSourceJsonType declaration
function(): IMDataSourceJsonThe data source JSON object in app config.
Returns
IMDataSourceJsongetDataView
Interface PropertygetDataView: (dataViewId: string) => DataSourceType declaration
function(dataViewId: string): DataSourceGet data view by data view ID.
Parameters
| Parameter | Type |
|---|---|
data | string |
Returns
DataSourcegetDataViews
Interface PropertygetDataViews: () => DataSource[]Type declaration
function(): DataSource[]Return all data views created from a main data source.
Returns
DataSource[]getIdField
Interface PropertygetIdField: () => stringType declaration
function(): stringReturn the data source ID field.
Returns
stringgetInfo
Interface PropertygetInfo: () => IMDataSourceInfoType declaration
function(): IMDataSourceInfoReturn the data source info in redux store.
Returns
IMDataSourceInfogetLabel
Interface PropertygetLabel: () => stringType declaration
function(): stringReturn data source label.
Returns
stringgetListenSelection
Interface PropertygetListenSelection: () => booleanType declaration
function(): booleanReturn whether listen selection.
Returns
booleangetLocalDataSource
Interface PropertygetLocalDataSource: (localId: string) => DataSourceType declaration
function(localId: string): DataSourceGet local data source by local ID.
Parameters
| Parameter | Type |
|---|---|
local | string |
Returns
DataSourcegetLocalDataSources
Interface PropertygetLocalDataSources: () => DataSource[]Type declaration
function(): DataSource[]Return all local data sources created from a main data source or data view.
Returns
DataSource[]getMainDataSource
Interface PropertygetMainDataSource: () => DataSourceType declaration
function(): DataSourceReturn the main data source.
Returns
DataSourcegetRecord
Interface PropertygetRecord: (index: number) => DataRecordType declaration
function(index: number): DataRecordGet record by index
Parameters
| Parameter | Type |
|---|---|
index | number |
Returns
DataRecordgetRecordById
Interface PropertygetRecordById: (id: string) => DataRecordType declaration
function(id: string): DataRecordGet record by ID
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
DataRecordgetRecords
Interface PropertygetRecords: () => DataRecord[]Type declaration
function(): DataRecord[]Get records
Returns
DataRecord[]getRecordsWithSelection
Interface PropertygetRecordsWithSelection: () => DataRecord[]Type declaration
function(): DataRecord[]If selected records are not loaded in the current data source, they will be concatenated to the end of records array. For example, record 1 is selected in data view 1 and it is not loaded in data view 2 (record 1 actually matches query params of data view 2), dataView2.getRecordsWithSelection() will return all loaded records in data view 2 and record 1.
Returns
DataRecord[]getRootDataSource
Interface PropertygetRootDataSource: () => DataSourceType declaration
function(): DataSourceReturn the root data source.
Returns
DataSourcegetSchema
Interface PropertygetSchema: () => IMDataSourceSchemaType declaration
function(): IMDataSourceSchemaThe schema returned here is the merged result of the configured schema and the fetched schema.
Returns
IMDataSourceSchemagetSelectedRecordIds
getSelectedRecordIds: () => string[]Type declaration
function(): string[]Get selected record IDs
Returns
string[]getSelectedRecordIndexes
getSelectedRecordIndexes: () => number[]Type declaration
function(): number[]Get selected record indexes
Returns
number[]getSelectedRecords
getSelectedRecords: () => DataRecord[]Type declaration
function(): DataRecord[]Get selected records
Returns
DataRecord[]getSourceRecords
Interface PropertygetSourceRecords: () => DataRecord[]Type declaration
function(): DataRecord[]Return the source records
Returns
DataRecord[]getSourceVersion
Interface PropertygetSourceVersion: () => numberType declaration
function(): numberWhen current data source is created from an array of records, it will be saved in sourceRecords .
Return the version of sourceRecords .
Returns
numbergetStatus
Interface PropertygetStatus: () => DataSourceStatusType declaration
function(): DataSourceStatusReturn data source status.
Returns
DataSourceStatusgetVersion
Interface PropertygetVersion: () => numberType declaration
function(): numberReturn data source version.
Returns
numberisDataSourceSet
Interface PropertyisDataSourceSet: booleanWhether a data source contains child data sources.
A dataset data source should create all its child data sources before ready() is resolved.
isDataView
Interface PropertyisDataView: booleanTrue means the data source is a data view. For local data source, this is false even the local data source is created from a data view.
isInAppConfig
Interface PropertyisInAppConfig: () => booleanType declaration
function(): booleanReturn whether the data source is added in builder and is saved in app config.
Returns
booleanparentDataSource
Interface PropertyparentDataSource: DataSourceThe parent data source of this data source, mull means it's a root data source.
ready
Interface Propertyready: () => Promise<any>Type declaration
function(): Promise<any>Ready is resolved means the data source instance is ready for use.
Returns
Promise<any>selectRecordById
selectRecordById: (id: string, record?: DataRecord, forceCheck?: boolean) => voidType declaration
function(id: string, record?: DataRecord, forceCheck?: boolean): voidSelect a record by ID.
When select record by ID, we can pass in the record. So when the selected record is not loaded, we can add it in.
If forceCheck is true, will check whether the record match filters of the data source or not. Will select the record only if the check is passed.
Parameters
| Parameter | Type | Notes |
|---|---|---|
id | string | The ID to be selected. The selection will be cleared if the ID is null. |
record | DataRecord | |
force | boolean |
Returns
voidselectRecordsByIds
selectRecordsByIds: (ids: string[], records?: DataRecord[], forceCheck?: boolean) => voidType declaration
function(ids: string[], records?: DataRecord[], forceCheck?: boolean): voidSelect records by IDs.
When select records by IDs, we can pass in the records. So when the selected records are not loaded, we can add them in.
If forceCheck is true, will check whether these records match filters of the data source or not. Will select the records which check is passed.
Parameters
| Parameter | Type | Notes |
|---|---|---|
ids | string[] | The IDs to be selected. The selection will be cleared if the IDs are null. |
records | DataRecord[] | |
force | boolean |
Returns
voidsetCountStatus
setCountStatus: (status: DataSourceStatus) => voidType declaration
function(status: DataSourceStatus): voidUpdate data source count status.
Parameters
| Parameter | Type |
|---|---|
status | DataSourceStatus |
Returns
voidsetDataSourceJson
Interface PropertysetDataSourceJson: (dsJson: IMDataSourceJson) => voidType declaration
function(dsJson: IMDataSourceJson): voidUpdate data source JSON in data source instance
Parameters
| Parameter | Type |
|---|---|
d | IMDataSourceJson |
Returns
voidsetListenSelection
Interface PropertysetListenSelection: (listen: boolean) => voidType declaration
function(listen: boolean): voidWhether listen selected records from other data sources which are derived from the same main data source. If true, will update selected record IDs of current data source info when selecting records via other derived data sources. Will also update selected record IDs when selecting records via current data source itself. If false, won't change selected record IDs when selecting records via other derived data sources. Will update selected record IDs only when selecting records via current data source itself.
Main data source and its data views will listen selected records by default, local data source does not listen selected records by default.
Parameters
| Parameter | Type |
|---|---|
listen | boolean |
Returns
voidsetRecords
Interface PropertysetRecords: (records: DataRecord[]) => voidType declaration
function(records: DataRecord[]): voidUpdate the records in the data source object only, does not update the source data.
Parameters
| Parameter | Type |
|---|---|
records | DataRecord[] |
Returns
voidsetSourceRecords
Interface PropertysetSourceRecords: (records: DataRecord[]) => voidType declaration
function(records: DataRecord[]): voidWhen current data source is created from an array of records, will save it in sourceRecords .
These two methods are used to update or get the source data.
Parameters
| Parameter | Type |
|---|---|
records | DataRecord[] |
Returns
voidsetStatus
setStatus: (status: DataSourceStatus) => voidType declaration
function(status: DataSourceStatus): voidUpdate data source status.
Parameters
| Parameter | Type |
|---|---|
status | DataSourceStatus |
Returns
voidupdateSelectionInfo
updateSelectionInfo: (ids: string[], triggerDataSource: DataSource, forceCheck?: boolean) => voidType declaration
function(ids: string[], triggerDataSource: DataSource, forceCheck?: boolean): voidUpdate selected record IDs in data source info if the current data source listens selection change (see setListenSelection ) or the current data source is the trigger data source (that is to say, select via it).
Before update info, will check whether these selected records match filters of the current data source firstly, and then only set the matched selected records to info.
Will skip the check in some cases to improve performance if the forceCheck is not passed in or is false. For example, if the curren data source is main data source (we suppose that main data source contains all records, no need to check).
But if the forceCheck is true, won't skip the check.
Parameters
| Parameter | Type |
|---|---|
ids | string[] |
trigger | DataSource |
force | boolean |
Returns
void
addSourceVersion: () => voidType declaration
function(): voidWhen current data source is created from an array of records, it will be saved in
sourceRecords. Add the version ofsourceRecords.setSourceRecordswill add the version by default.Returns
void