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.

Subclasses: QueriableDataSource, AbstractArcGISLayerFolderDataSource

Properties

Property	Type	Notes
`addSourceVersion`	`() => void`
`addVersion`	`() => void`
`areChildDataSourcesCreated`	`() => boolean`
`belongToDataSource`	`DataSource`	The data source which this data source derives from.
`buildRecord`	`(data: any) => DataRecord`
`childDataSourcesReady`	`() => Promise<DataSource[]>`
`clearRecords`	`() => void`
`clearSourceRecords`	`() => void`
`count`	`number`	The total records count depends on the current query
`createDataSourceById`	`(dataSourceId: string) => Promise<DataSource>`
`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`
`fetchSchema`	`() => Promise<IMDataSourceSchema>`
`getAllChildDataSources`	`() => DataSource[]`
`getAllDerivedDataSources`	`() => DataSource[]`
`getChildDataSource`	`(jimuChildId: string) => DataSource`
`getChildDataSources`	`() => DataSource[]`
`getCountStatus`	`() => DataSourceStatus`
`getDataSourceJson`	`() => IMDataSourceJson`
`getDataView`	`(dataViewId: string) => DataSource`
`getDataViewConfig`	`() => IMDataViewJson`
`getDataViews`	`() => DataSource[]`
`getIdField`	`() => string`
`getInfo`	`() => IMDataSourceInfo`
`getLabel`	`() => string`
`getListenSelection`	`() => boolean`
`getLocalDataSource`	`(localId: string) => DataSource`
`getLocalDataSources`	`() => DataSource[]`
`getMainDataSource`	`() => DataSource`
`getRecord`	`(index: number) => DataRecord`
`getRecordById`	`(id: string) => DataRecord`
`getRecords`	`() => DataRecord[]`
`getRecordsWithSelection`	`() => DataRecord[]`
`getRootDataSource`	`() => DataSource`
`getSchema`	`() => IMDataSourceSchema`
`getSelectedRecordIds`	`() => string[]`
`getSelectedRecordIndexes`	`() => number[]`
`getSelectedRecords`	`() => DataRecord[]`
`getSourceRecords`	`() => DataRecord[]`
`getSourceVersion`	`() => number`
`getStatus`	`() => DataSourceStatus`
`getVersion`	`() => number`
`id`	`string`	The data source ID.
`isDataSourceSet`	`boolean`	Whether 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` .
`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`
`isLocal`	`boolean`	True means the data source is a local data source.
`localId`	`string`	The local ID of the data source.
`order`	`number`	Order in the parent data source.
`parentDataSource`	`DataSource`	The parent data source of this data source, mull means it's a root data source.
`ready`	`() => Promise<any>`
`selectRecordById`	`(id: string, record?: DataRecord) => void`
`selectRecords`	`(options: SelectOptions) => Promise<Pick<QueryResult, "records">>`
`selectRecordsByIds`	`(ids: string[], records?: DataRecord[]) => void`
`setCountStatus`	`(status: DataSourceStatus) => void`
`setDataSourceJson`	`(dsJson: IMDataSourceJson) => void`
`setListenSelection`	`(listen: boolean) => void`
`setRecords`	`(records: DataRecord[]) => void`
`setSourceRecords`	`(records: DataRecord[]) => void`
`setStatus`	`(status: DataSourceStatus) => void`
`type`	`string`	The type of the data source.
`updateSelectionInfo`	`(options: SelectOptions, triggerDataSource: DataSource, forceCheck?: boolean) => void`

addSourceVersion

Interface Property

addSourceVersion: () => void

Type declaration

function(): 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 Property

addVersion: () => void

Type declaration

function(): void

Update data source version.

Returns

void

areChildDataSourcesCreated

optional

Interface Property

areChildDataSourcesCreated: () => boolean

Type declaration

function(): boolean

Return 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

boolean

belongToDataSource

optional

Interface Property

belongToDataSource: DataSource

The data source which this data source derives from.

buildRecord

Interface Property

buildRecord: (data: any) => DataRecord

Type declaration

function(data: any): DataRecord

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

Parameters

Parameter	Type
`data`	any

Returns

DataRecord

childDataSourcesReady

optional

Interface Property

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

optional

Interface Property

clearRecords: () => void

Type declaration

function(): 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 Property

clearSourceRecords: () => void

Type declaration

function(): void

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

Returns

void

count

optional

Interface Property

count: number

The total records count depends on the current query

createDataSourceById

optional

Interface Property

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
`dataSourceId`	string

Returns

Promise<DataSource>

dataSourceManager

Interface Property

dataSourceManager: DataSourceManager

The data source manager, which is used to manage the data source, including create/get/destroy the data source instance.

dataViewId

optional

Interface Property

dataViewId: string

The data view ID configured in JSON.

destroy

Interface Property

destroy: () => void

Type declaration

function(): void

Destroy the data source.

Returns

void

fetchSchema

Interface Property

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

optional

Interface Property

getAllChildDataSources: () => DataSource[]

Type declaration

function(): DataSource[]

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

Returns

DataSource[]

getAllDerivedDataSources

Interface Property

getAllDerivedDataSources: () => DataSource[]

Type declaration

function(): DataSource[]

Return the derived data views and local data sources.

Returns

DataSource[]

getChildDataSource

optional

Interface Property

getChildDataSource: (jimuChildId: string) => DataSource

Type declaration

function(jimuChildId: string): DataSource

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

Parameters

Parameter	Type
`jimuChildId`	string

Returns

DataSource

getChildDataSources

optional

Interface Property

getChildDataSources: () => DataSource[]

Type declaration

function(): DataSource[]

Return child data sources of a parent data source.

Returns

DataSource[]

getCountStatus

Interface Property

getCountStatus: () => DataSourceStatus

Type declaration

function(): DataSourceStatus

Return data source count status.

Returns

DataSourceStatus

getDataSourceJson

Interface Property

getDataSourceJson: () => IMDataSourceJson

Type declaration

function(): IMDataSourceJson

The data source JSON object in app config.

Returns

IMDataSourceJson

getDataView

Interface Property

getDataView: (dataViewId: string) => DataSource

Type declaration

function(dataViewId: string): DataSource

Get data view by data view ID.

Parameters

Parameter	Type
`dataViewId`	string

Returns

DataSource

getDataViewConfig

Interface Property

getDataViewConfig: () => IMDataViewJson

Type declaration

function(): IMDataViewJson

Return the config of the current data source.

Returns

IMDataViewJson

getDataViews

Interface Property

getDataViews: () => DataSource[]

Type declaration

function(): DataSource[]

Return all data views created from a main data source.

Returns

DataSource[]

getIdField

Interface Property

getIdField: () => string

Type declaration

function(): string

Return the data source ID field.

Returns

string

getInfo

Interface Property

getInfo: () => IMDataSourceInfo

Type declaration

function(): IMDataSourceInfo

Return the data source info in redux store.

Returns

IMDataSourceInfo

getLabel

Interface Property

getLabel: () => string

Type declaration

function(): string

Return data source label.

Returns

string

getListenSelection

Interface Property

getListenSelection: () => boolean

Type declaration

function(): boolean

Return whether listen selection.

Returns

boolean

getLocalDataSource

Interface Property

getLocalDataSource: (localId: string) => DataSource

Type declaration

function(localId: string): DataSource

Get local data source by local ID.

Parameters

Parameter	Type
`localId`	string

Returns

DataSource

getLocalDataSources

Interface Property

getLocalDataSources: () => DataSource[]

Type declaration

function(): DataSource[]

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

Returns

DataSource[]

getMainDataSource

Interface Property

getMainDataSource: () => DataSource

Type declaration

function(): DataSource

Return the main data source.

Returns

DataSource

getRecord

Interface Property

getRecord: (index: number) => DataRecord

Type declaration

function(index: number): DataRecord

Get record by index

Parameters

Parameter	Type
`index`	number

Returns

DataRecord

getRecordById

Interface Property

getRecordById: (id: string) => DataRecord

Type declaration

function(id: string): DataRecord

Get record by ID

Parameters

Parameter	Type
`id`	string

Returns

DataRecord

getRecords

Interface Property

getRecords: () => DataRecord[]

Type declaration

function(): DataRecord[]

Get records

Returns

DataRecord[]

getRecordsWithSelection

Interface Property

getRecordsWithSelection: () => 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 Property

getRootDataSource: () => DataSource

Type declaration

function(): DataSource

Return the root data source.

Returns

DataSource

getSchema

Interface Property

getSchema: () => IMDataSourceSchema

Type declaration

function(): 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.

Returns

IMDataSourceSchema

getSelectedRecordIds

Interface Property

getSelectedRecordIds: () => string[]

Type declaration

function(): string[]

Get selected record IDs

Returns

string[]

getSelectedRecordIndexes

Interface Property

getSelectedRecordIndexes: () => number[]

Type declaration

function(): number[]

Get selected record indexes

Returns

number[]

getSelectedRecords

Interface Property

getSelectedRecords: () => DataRecord[]

Type declaration

function(): DataRecord[]

Get selected records

Returns

DataRecord[]

getSourceRecords

Interface Property

getSourceRecords: () => DataRecord[]

Type declaration

function(): DataRecord[]

Return the source records

Returns

DataRecord[]

getSourceVersion

Interface Property

getSourceVersion: () => number

Type declaration

function(): 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 Property

getStatus: () => DataSourceStatus

Type declaration

function(): DataSourceStatus

Return data source status.

Returns

DataSourceStatus

getVersion

Interface Property

getVersion: () => number

Type declaration

function(): number

Return data source version.

Returns

number

id

Interface Property

id: string

The data source ID.

isDataSourceSet

Interface Property

isDataSourceSet: boolean

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

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.

isInAppConfig

Interface Property

isInAppConfig: () => boolean

Type declaration

function(): boolean

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

Returns

boolean

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.

ready

Interface Property

ready: () => Promise<any>

Type declaration

function(): 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 .

Returns

Promise<any>

selectRecordById

Interface Property

selectRecordById: (id: string, record?: DataRecord) => void

Type declaration

function(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.

Parameters

Parameter	Type	Notes
`id`	string	The ID to be selected. The selection will be cleared if the ID is null.
`record`	DataRecord

Returns

void

selectRecords

Interface Property

selectRecords: (options: SelectOptions) => Promise<Pick<QueryResult, "records">>

Type declaration

function(options: SelectOptions): Promise<Pick<QueryResult, "records">>

Select records.

Parameters

Parameter	Type
`options`	SelectOptions

Returns

Promise<Pick<QueryResult, "records">>

selectRecordsByIds

Interface Property

selectRecordsByIds: (ids: string[], records?: DataRecord[]) => void

Type declaration

function(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.

Parameters

Parameter	Type	Notes
`ids`	string[]	The IDs to be selected. The selection will be cleared if the IDs are null.
`records`	DataRecord[]

Returns

void

setCountStatus

optional

Interface Property

setCountStatus: (status: DataSourceStatus) => void

Type declaration

function(status: DataSourceStatus): void

Update data source count status.

Parameters

Parameter	Type
`status`	DataSourceStatus

Returns

void

setDataSourceJson

Interface Property

setDataSourceJson: (dsJson: IMDataSourceJson) => void

Type declaration

function(dsJson: IMDataSourceJson): void

Update data source JSON in data source instance

Parameters

Parameter	Type
`dsJson`	IMDataSourceJson

Returns

void

setListenSelection

Interface Property

setListenSelection: (listen: boolean) => void

Type declaration

function(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.

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

void

setRecords

Interface Property

setRecords: (records: DataRecord[]) => void

Type declaration

function(records: DataRecord[]): void

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

Parameters

Parameter	Type
`records`	DataRecord[]

Returns

void

setSourceRecords

Interface Property

setSourceRecords: (records: DataRecord[]) => void

Type declaration

function(records: DataRecord[]): void

When 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

void

setStatus

optional

Interface Property

setStatus: (status: DataSourceStatus) => void

Type declaration

function(status: DataSourceStatus): void

Update data source status.

Parameters

Parameter	Type
`status`	DataSourceStatus

Returns

void

type

Interface Property

type: string

The type of the data source.

updateSelectionInfo

Interface Property

updateSelectionInfo: (options: SelectOptions, triggerDataSource: DataSource, forceCheck?: boolean) => void

Type declaration

function(options: SelectOptions, triggerDataSource: DataSource, forceCheck?: boolean): void

Update 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 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
`options`	SelectOptions
`triggerDataSource`	DataSource
`forceCheck`	boolean

Returns

void

ArcGIS Experience BuilderAPI Reference

DataSource

Interface

Properties

Type declaration

Returns

Type declaration

Returns

Type declaration

Returns

Type declaration

Parameters

Returns

Type declaration

Returns

Type declaration

Returns

Type declaration

Returns

Type declaration

Parameters

Returns

Type declaration

Returns

Type declaration

Returns

Type declaration

Returns

Type declaration

Returns

Type declaration

Parameters

Returns

Type declaration

Returns

Type declaration

Returns

Type declaration

Returns

Type declaration

Parameters

Returns

Type declaration

Returns

Type declaration

Returns

Type declaration

Returns

Type declaration

Returns

Type declaration

Returns

Type declaration

Returns

Type declaration

Parameters

Returns

Type declaration

Returns

Type declaration

Returns

Type declaration

Parameters

Returns

Type declaration

Parameters

Returns

Type declaration

Returns

Type declaration

Returns

Type declaration

Returns

Type declaration

Returns

Type declaration

Returns

Type declaration

Returns

Type declaration