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 connect 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 |
|---|---|---|
addSourceVersion | () => void | When current data source is created from an array of records, it will be saved in |
addVersion | () => void | Update data source version. |
belongToDataSource | DataSource | The data source which this data source derives from. |
buildRecord | (data: any) => DataRecord | Builds a data record only -- does not add the record into data source. |
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. |
clearSourceRecords | () => void | Clear both sourceRecords and loaded records. Both source version and version in data source info will be updated. |
count | number | The total records count depends on the current query |
dataSourceManager | DataSourceManager | The data source manager, which is used to manage the data source, including create/get/destroy the data source instance. |
dataViewId | string | The data view ID configured in JSON. |
destroy | () => void | Destroy the data source. |
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. |
getAllDerivedDataSources | () => DataSource[] | Return the derived data views and local data sources. |
getCountStatus | () => DataSourceStatus | Return data source count status. |
getDataSourceJson | () => IMDataSourceJson | The data source JSON object in app config. |
getDataView | (dataViewId: string) => DataSource | Get data view by data view ID. |
getDataViewConfig | () => IMDataViewJson | Return the config of the current data source. |
getDataViews | () => DataSource[] | Return all data views created from a main data source. |
getIdField | () => string | Return the data source ID field. |
getInfo | () => IMDataSourceInfo | Return the data source info in redux store. |
getLabel | () => string | Return data source label. |
getListenSelection | () => boolean | Return whether listen selection. |
getLocalDataSource | (localId: string) => DataSource | Get local data source by local ID. |
getLocalDataSources | () => DataSource[] | Return all local data sources created from a main data source or data view. |
getMainDataSource | () => DataSource | Return the main data source. |
getRecord | (index: number) => DataRecord | Get record by index |
getRecordById | (id: string) => DataRecord | Get record by ID |
getRecords | () => DataRecord[] | Get records |
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. |
getRootDataSource | () => DataSource | Return the root data source. |
getSchema | () => IMDataSourceSchema | The schema returned here is the merged result of the configured schema and the fetched schema. The configured schema is the user's changes, such as a new data source name. The fetched schema is the original schema from AGOL/portal item or a remote database, such as the service name, the fields and the filters. |
getSelectedRecordIds | () => string[] | Get selected record IDs |
getSelectedRecordIndexes | () => number[] | Get selected record indexes |
getSelectedRecords | () => DataRecord[] | Get selected records |
getSelectionDataView | () => DataSource | Get selection data view |
getSourceRecords | () => DataRecord[] | Return the source records |
getSourceVersion | () => number | When current data source is created from an array of records, it will be saved in |
getStatus | () => DataSourceStatus | Return data source status. |
getVersion | () => number | Return data source version. |
id | string | The data source ID. |
isDataSourceSet | () => thisisDataSource & SetDataSourceMixin | Whether a data source contains child data sources.
A set data source won't create all its child data sources when |
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. |
isInAppConfig | () => boolean | Return whether the data source is added in builder and is saved in app config. |
isLocal | boolean | True means the data source is a local data source. |
isSelectionView | () => boolean | Determine whether the data source is a selection view. |
localId | string | The local ID of the data source. |
order | number | Order in the parent data source. |
parentDataSource | DataSource & SetDataSourceMixin | The parent data source of this data source, mull means it's a root data source. |
ready | () => Promise<any> | 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 |
selectRecordById | (id: string, record?: DataRecord) => 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. |
selectRecords | (options: SelectOptions) => Promise<Pick<QueryResult, "records">> | Select records. |
selectRecordsByIds | (ids: string[], records?: DataRecord[]) => 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. |
setCountStatus | (status: DataSourceStatus) => void | Update data source count status. |
setDataSourceJson | (dsJson: IMDataSourceJson) => void | Update data source JSON in data source instance |
setListenSelection | (listen: boolean) => 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: DataRecord[]) => void | Update the records in the data source object only, does not update the source data. |
setSourceRecords | (records: DataRecord[]) => void | When current data source is created from an array of records, will save it in |
setStatus | (status: DataSourceStatus) => void | Update data source status. |
type | string | The type of the data source. |
updateSelectionInfo | (options: SelectOptions, triggerDataSource: DataSource, forceCheck?: boolean) => void | Update selected records in data source info if the current data source listens selection change (see |
addSourceVersion
Interface PropertyaddSourceVersion: () => voidWhen 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.
Type declaration
function(): voidReturns
voidaddVersion
addVersion: () => voidUpdate data source version.
Type declaration
function(): voidReturns
voidbelongToDataSource
belongToDataSource: DataSourceThe data source which this data source derives from.
buildRecord
Interface PropertybuildRecord: (data: any) => DataRecordBuilds a data record only -- does not add the record into data source.
Type declaration
function(data: any): DataRecordParameters
| Parameter | Type |
|---|---|
data | any |
Returns
DataRecordclearRecords
clearRecords: () => 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.
Type declaration
function(): voidReturns
voidclearSourceRecords
Interface PropertyclearSourceRecords: () => voidClear both sourceRecords and loaded records. Both source version and version in data source info will be updated.
Type declaration
function(): voidReturns
voiddataSourceManager
Interface PropertydataSourceManager: DataSourceManagerThe data source manager, which is used to manage the data source, including create/get/destroy the data source instance.
destroy
Interface Propertydestroy: () => voidDestroy the data source.
Type declaration
function(): voidReturns
voidfetchSchema
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>getAllDerivedDataSources
Interface PropertygetAllDerivedDataSources: () => DataSource[]Return the derived data views and local data sources.
Type declaration
function(): DataSource[]Returns
DataSource[]getCountStatus
Interface PropertygetCountStatus: () => DataSourceStatusReturn data source count status.
Type declaration
function(): DataSourceStatusReturns
DataSourceStatusgetDataSourceJson
Interface PropertygetDataSourceJson: () => IMDataSourceJsonThe data source JSON object in app config.
Type declaration
function(): IMDataSourceJsonReturns
IMDataSourceJsongetDataView
Interface PropertygetDataView: (dataViewId: string) => DataSourceGet data view by data view ID.
Type declaration
function(dataViewId: string): DataSourceParameters
| Parameter | Type |
|---|---|
data | string |
Returns
DataSourcegetDataViewConfig
Interface PropertygetDataViewConfig: () => IMDataViewJsonReturn the config of the current data source.
Type declaration
function(): IMDataViewJsonReturns
IMDataViewJsongetDataViews
Interface PropertygetDataViews: () => DataSource[]Return all data views created from a main data source.
Type declaration
function(): DataSource[]Returns
DataSource[]getIdField
Interface PropertygetIdField: () => stringReturn the data source ID field.
Type declaration
function(): stringReturns
stringgetInfo
Interface PropertygetInfo: () => IMDataSourceInfoReturn the data source info in redux store.
Type declaration
function(): IMDataSourceInfoReturns
IMDataSourceInfogetLabel
Interface PropertygetLabel: () => stringReturn data source label.
Type declaration
function(): stringReturns
stringgetListenSelection
Interface PropertygetListenSelection: () => booleanReturn whether listen selection.
Type declaration
function(): booleanReturns
booleangetLocalDataSource
Interface PropertygetLocalDataSource: (localId: string) => DataSourceGet local data source by local ID.
Type declaration
function(localId: string): DataSourceParameters
| Parameter | Type |
|---|---|
local | string |
Returns
DataSourcegetLocalDataSources
Interface PropertygetLocalDataSources: () => DataSource[]Return all local data sources created from a main data source or data view.
Type declaration
function(): DataSource[]Returns
DataSource[]getMainDataSource
Interface PropertygetMainDataSource: () => DataSourceReturn the main data source.
Type declaration
function(): DataSourceReturns
DataSourcegetRecord
Interface PropertygetRecord: (index: number) => DataRecordGet record by index
Type declaration
function(index: number): DataRecordParameters
| Parameter | Type |
|---|---|
index | number |
Returns
DataRecordgetRecordById
Interface PropertygetRecordById: (id: string) => DataRecordGet record by ID
Type declaration
function(id: string): DataRecordParameters
| Parameter | Type |
|---|---|
id | string |
Returns
DataRecordgetRecords
Interface PropertygetRecords: () => DataRecord[]Get records
Type declaration
function(): DataRecord[]Returns
DataRecord[]getRecordsWithSelection
Interface PropertygetRecordsWithSelection: () => 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.
Type declaration
function(): DataRecord[]Returns
DataRecord[]getRootDataSource
Interface PropertygetRootDataSource: () => DataSourceReturn the root data source.
Type declaration
function(): DataSourceReturns
DataSourcegetSchema
Interface PropertygetSchema: () => IMDataSourceSchemaThe schema returned here is the merged result of the configured schema and the fetched schema. The configured schema is the user's changes, such as a new data source name. The fetched schema is the original schema from AGOL/portal item or a remote database, such as the service name, the fields and the filters.
Type declaration
function(): IMDataSourceSchemaReturns
IMDataSourceSchemagetSelectedRecordIds
Interface PropertygetSelectedRecordIds: () => string[]Get selected record IDs
Type declaration
function(): string[]Returns
string[]getSelectedRecordIndexes
Interface PropertygetSelectedRecordIndexes: () => number[]Get selected record indexes
Type declaration
function(): number[]Returns
number[]getSelectedRecords
Interface PropertygetSelectedRecords: () => DataRecord[]Get selected records
Type declaration
function(): DataRecord[]Returns
DataRecord[]getSelectionDataView
Interface PropertygetSelectionDataView: () => DataSourceGet selection data view
Type declaration
function(): DataSourceReturns
DataSourcegetSourceRecords
Interface PropertygetSourceRecords: () => DataRecord[]Return the source records
Type declaration
function(): DataRecord[]Returns
DataRecord[]getSourceVersion
Interface PropertygetSourceVersion: () => numberWhen current data source is created from an array of records, it will be saved in sourceRecords .
Return the version of sourceRecords .
Type declaration
function(): numberReturns
numbergetStatus
Interface PropertygetStatus: () => DataSourceStatusReturn data source status.
Type declaration
function(): DataSourceStatusReturns
DataSourceStatusgetVersion
Interface PropertygetVersion: () => numberReturn data source version.
Type declaration
function(): numberReturns
numberisDataSourceSet
Interface PropertyisDataSourceSet: () => thisisDataSource & SetDataSourceMixinWhether a data source contains child data sources.
A set data source won't create all its child data sources when ready is resolved.
To make sure all child data sources are created, please use childDataSourcesReady .
Type declaration
function(): thisisDataSource & SetDataSourceMixinReturns
thisisDataSource & SetDataSourceMixinisDataView
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: () => booleanReturn whether the data source is added in builder and is saved in app config.
Type declaration
function(): booleanReturns
booleanisSelectionView
Interface PropertyisSelectionView: () => booleanDetermine whether the data source is a selection view.
Type declaration
function(): booleanReturns
booleanparentDataSource
Interface PropertyparentDataSource: DataSource & SetDataSourceMixinThe parent data source of this data source, mull means it's a root data source.
ready
Interface Propertyready: () => Promise<any>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<any>Returns
Promise<any>selectRecordById
Interface PropertyselectRecordById: (id: string, record?: DataRecord) => 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.
Type declaration
function(id: string, record?: DataRecord): voidParameters
| Parameter | Type | Notes |
|---|---|---|
id | string | The ID to be selected. The selection will be cleared if the ID is null. |
record | DataRecord |
Returns
voidselectRecords
Interface PropertyselectRecords: (options: SelectOptions) => Promise<Pick<QueryResult, "records">>Select records.
Type declaration
function(options: SelectOptions): Promise<Pick<QueryResult, "records">>Parameters
| Parameter | Type |
|---|---|
options | SelectOptions |
Returns
Promise<Pick<QueryResult, "records">>selectRecordsByIds
Interface PropertyselectRecordsByIds: (ids: string[], records?: DataRecord[]) => 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.
Type declaration
function(ids: string[], records?: DataRecord[]): voidParameters
| Parameter | Type | Notes |
|---|---|---|
ids | string[] | The IDs to be selected. The selection will be cleared if the IDs are null. |
records | DataRecord[] |
Returns
voidsetCountStatus
setCountStatus: (status: DataSourceStatus) => voidUpdate data source count status.
Type declaration
function(status: DataSourceStatus): voidParameters
| Parameter | Type |
|---|---|
status | DataSourceStatus |
Returns
voidsetDataSourceJson
Interface PropertysetDataSourceJson: (dsJson: IMDataSourceJson) => voidUpdate data source JSON in data source instance
Type declaration
function(dsJson: IMDataSourceJson): voidParameters
| Parameter | Type |
|---|---|
ds | IMDataSourceJson |
Returns
voidsetListenSelection
Interface PropertysetListenSelection: (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.
Type declaration
function(listen: boolean): voidParameters
| Parameter | Type |
|---|---|
listen | boolean |
Returns
voidsetRecords
Interface PropertysetRecords: (records: DataRecord[]) => voidUpdate the records in the data source object only, does not update the source data.
Type declaration
function(records: DataRecord[]): voidParameters
| Parameter | Type |
|---|---|
records | DataRecord[] |
Returns
voidsetSourceRecords
Interface PropertysetSourceRecords: (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.
Type declaration
function(records: DataRecord[]): voidParameters
| Parameter | Type |
|---|---|
records | DataRecord[] |
Returns
voidsetStatus
setStatus: (status: DataSourceStatus) => voidUpdate data source status.
Type declaration
function(status: DataSourceStatus): voidParameters
| Parameter | Type |
|---|---|
status | DataSourceStatus |
Returns
voidupdateSelectionInfo
Interface PropertyupdateSelectionInfo: (options: SelectOptions, triggerDataSource: DataSource, forceCheck?: boolean) => voidUpdate selected records 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 current 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.
Type declaration
function(options: SelectOptions, triggerDataSource: DataSource, forceCheck?: boolean): voidParameters
| Parameter | Type |
|---|---|
options | SelectOptions |
trigger | DataSource |
force | boolean |
Returns
void