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

PropertyTypeNotes

The data source which this data source derives from.

number

The total records count depends on the current query

string

The data view ID configured in Json.

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 ready() is resolved.

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

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.

string

The type of the data source

belongToDataSource

optional
Interface Property
belongToDataSource: DataSource

The data source which this data source derives from.

count

optional
Interface Property
count: number

The total records count depends on the current query

dataViewId

optional
Interface Property
dataViewId: string

The data view ID configured in Json.

id

Interface Property
id: string

The data source ID.

isDataSourceSet

Interface Property
isDataSourceSet: boolean

Whether a data source contains child data sources. A dataset data source should create all its child data sources before ready() is resolved.

isDataView

Interface Property
isDataView: 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.

isLocal

Interface Property
isLocal: boolean

True means the data source is a local data source.

localId

optional
Interface Property
localId: string

The local ID of the data source.

order

optional
Interface Property
order: number

Order in the parent data source.

parentDataSource

Interface Property
parentDataSource: DataSource

The parent data source of this data source, mull means it's a root data source.

type

Interface Property
type: string

The type of the data source

Methods

MethodReturnsNotes
void

When current data source is created from an array of records, it will be saved in sourceRecords. Add the version of sourceRecords.setSourceRecords will add the version by default.

void

Update data source version.

Builds a data record only -- does not add the record into data source.

void

This 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.

void

Clear both sourceRecords and loaded records. Both source version and version in data source info will be updated.

Fetch the data schema from an actual data source. If it's a statistic data source, the schema will not be fetched.

Return all child data sources of a parent data source, includes the grandchildren

Return the derived data views and local data sources.

getChildDataSource(jimuChildId)

Get child data source by jimuChildId. You can get jimuChildId by getJimuChildId().

Return child data sources of a parent data source.

Return data source count status.

IMDataSourceJson

The data source JSON object in app config.

getDataView(dataViewId)

Get data view by data view ID.

Return all data views created from a main data source.

string

Return the data source ID field.

IMDataSourceInfo

Return the data source info in redux store.

string

Return data source label.

boolean

Return whether listen selection.

Get local data source by local ID.

Return all local data sources created from a main data source or data view.

Return the main data source.

getRecord(index)

Get record by index

Get record by ID

Get records

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.

Return the root data source.

The schema returned here is the merged result of the configured schema and the fetched schema.

string[]

Get selected record IDs

number[]

Get selected record indexes

Get selected records

Return the source records

number

When current data source is created from an array of records, it will be saved in sourceRecords. Return the version of sourceRecords.

Return data source status.

number

Return data source version.

boolean

Return whether the data source is added in builder and is saved in app config.

Promise<any>

Ready is resolved means the data source instance is ready for use.

selectRecordById(id, record?, forceCheck?)
void

Select 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.

selectRecordsByIds(ids, records?, forceCheck?)
void

Select 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.

void

Update data source count status.

void

Update data source JSON in data source instance

void

Whether 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.

setRecords(records)
void

Update the records in the data source object only, does not update the source data. See DataSourceEditSourceOperations.updateRecords

void

When current data source is created from an array of records, will save it in sourceRecords. These two methods are use to update or get the source data.

setStatus(status)
void

Update data source status.

updateSelectionInfo(ids, triggerDataSource, forceCheck?)
void

Update 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).

addSourceVersion

Interface Method
addSourceVersion(): void

When current data source is created from an array of records, it will be saved in sourceRecords. Add the version of sourceRecords.setSourceRecords will add the version by default.

Returns 
void

addVersion

optional
Interface Method
addVersion(): void

Update data source version.

Returns 
void

buildRecord

Interface Method
buildRecord(dataany): DataRecord

Builds a data record only -- does not add the record into data source.

Parameters
ParameterType
data
any
Returns 
DataRecord

clearRecords

optional
Interface Method
clearRecords(): void

This 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 
void

clearSourceRecords

Interface Method
clearSourceRecords(): void

Clear both sourceRecords and loaded records. Both source version and version in data source info will be updated.

Returns 
void

fetchSchema

Interface Method
fetchSchema(): 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

optional
Interface Method
getAllChildDataSources(): DataSource[]

Return all child data sources of a parent data source, includes the grandchildren

Returns 
DataSource[]

getAllDerivedDataSources

Interface Method
getAllDerivedDataSources(): DataSource[]

Return the derived data views and local data sources.

Returns 
DataSource[]

getChildDataSource

optional
Interface Method
getChildDataSource(jimuChildIdstring): DataSource

Get child data source by jimuChildId. You can get jimuChildId by getJimuChildId().

Parameters
ParameterType
jimuChildId
string
Returns 
DataSource

getChildDataSources

optional
Interface Method
getChildDataSources(): DataSource[]

Return child data sources of a parent data source.

Returns 
DataSource[]

getCountStatus

Interface Method
getCountStatus(): DataSourceStatus

Return data source count status.

Returns 
DataSourceStatus

getDataSourceJson

Interface Method
getDataSourceJson(): IMDataSourceJson

The data source JSON object in app config.

Returns 
IMDataSourceJson

getDataView

Interface Method
getDataView(dataViewIdstring): DataSource

Get data view by data view ID.

Parameters
ParameterType
dataViewId
string
Returns 
DataSource

getDataViews

Interface Method
getDataViews(): DataSource[]

Return all data views created from a main data source.

Returns 
DataSource[]

getIdField

Interface Method
getIdField(): string

Return the data source ID field.

Returns 
string

getInfo

Interface Method
getInfo(): IMDataSourceInfo

Return the data source info in redux store.

Returns 
IMDataSourceInfo

getLabel

Interface Method
getLabel(): string

Return data source label.

Returns 
string

getListenSelection

Interface Method
getListenSelection(): boolean

Return whether listen selection.

Returns 
boolean

getLocalDataSource

Interface Method
getLocalDataSource(localIdstring): DataSource

Get local data source by local ID.

Parameters
ParameterType
localId
string
Returns 
DataSource

getLocalDataSources

Interface Method
getLocalDataSources(): DataSource[]

Return all local data sources created from a main data source or data view.

Returns 
DataSource[]

getMainDataSource

Interface Method
getMainDataSource(): DataSource

Return the main data source.

Returns 
DataSource

getRecord

Interface Method
getRecord(indexnumber): DataRecord

Get record by index

Parameters
ParameterType
index
number
Returns 
DataRecord

getRecordById

Interface Method
getRecordById(idstring): DataRecord

Get record by ID

Parameters
ParameterType
id
string
Returns 
DataRecord

getRecords

Interface Method
getRecords(): DataRecord[]

Get records

Returns 
DataRecord[]

getRecordsWithSelection

Interface Method
getRecordsWithSelection(): 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 Method
getRootDataSource(): DataSource

Return the root data source.

Returns 
DataSource

getSchema

Interface Method
getSchema(): IMDataSourceSchema

The schema returned here is the merged result of the configured schema and the fetched schema.

Returns 
IMDataSourceSchema

getSelectedRecordIds

optional
Interface Method
getSelectedRecordIds(): string[]

Get selected record IDs

Returns 
string[]

getSelectedRecordIndexes

optional
Interface Method
getSelectedRecordIndexes(): number[]

Get selected record indexes

Returns 
number[]

getSelectedRecords

optional
Interface Method
getSelectedRecords(): DataRecord[]

Get selected records

Returns 
DataRecord[]

getSourceRecords

Interface Method
getSourceRecords(): DataRecord[]

Return the source records

Returns 
DataRecord[]

getSourceVersion

Interface Method
getSourceVersion(): number

When current data source is created from an array of records, it will be saved in sourceRecords. Return the version of sourceRecords.

Returns 
number

getStatus

Interface Method
getStatus(): DataSourceStatus

Return data source status.

Returns 
DataSourceStatus

getVersion

Interface Method
getVersion(): number

Return data source version.

Returns 
number

isInAppConfig

Interface Method
isInAppConfig(): boolean

Return whether the data source is added in builder and is saved in app config.

Returns 
boolean

ready

Interface Method
ready(): Promise<any>

Ready is resolved means the data source instance is ready for use.

Returns 
Promise<any>

selectRecordById

optional
Interface Method
selectRecordById(idstring, record?DataRecord, forceCheck?boolean): void

Select 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
ParameterTypeNotes
id
string

The ID to be selected. The selection will be cleared if the ID is null.

record
DataRecord
forceCheck
boolean
Returns 
void

selectRecordsByIds

optional
Interface Method
selectRecordsByIds(idsstring[], records?DataRecord[], forceCheck?boolean): void

Select 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
ParameterTypeNotes
ids
string[]

The IDs to be selected. The selection will be cleared if the IDs are null.

records
DataRecord[]
forceCheck
boolean
Returns 
void

setCountStatus

optional
Interface Method
setCountStatus(statusDataSourceStatus): void

Update data source count status.

Parameters
ParameterType
status
DataSourceStatus
Returns 
void

setDataSourceJson

Interface Method
setDataSourceJson(dsJsonIMDataSourceJson): void

Update data source JSON in data source instance

Parameters
ParameterType
dsJson
IMDataSourceJson
Returns 
void

setListenSelection

Interface Method
setListenSelection(listenboolean): void

Whether 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
ParameterType
listen
boolean
Returns 
void

setRecords

Interface Method
setRecords(recordsDataRecord[]): void

Update the records in the data source object only, does not update the source data. See DataSourceEditSourceOperations.updateRecords

Parameters
ParameterType
records
DataRecord[]
Returns 
void

setSourceRecords

Interface Method
setSourceRecords(recordsDataRecord[]): void

When current data source is created from an array of records, will save it in sourceRecords. These two methods are use to update or get the source data.

Parameters
ParameterType
records
DataRecord[]
Returns 
void

setStatus

optional
Interface Method
setStatus(statusDataSourceStatus): void

Update data source status.

Parameters
ParameterType
status
DataSourceStatus
Returns 
void

updateSelectionInfo

optional
Interface Method
updateSelectionInfo(idsstring[], triggerDataSourceDataSource, forceCheck?boolean): void

Update 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
ParameterType
ids
string[]
triggerDataSource
DataSource
forceCheck
boolean
Returns 
void

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.