SceneServiceDataSource

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.

Type declaration

function(): void

Returns 

void

Update data source version.

Type declaration

function(): void

Returns 

void

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

Type declaration

function(): boolean

Returns 

boolean

The data source which this data source derives from.

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

Type declaration

function(data: any): DataRecord

Parameters

Parameter	Type
data	any

Returns 

DataRecord

Change the GDB version for all layers in the service.

Type declaration

function(gdbVersion: string): void

Parameters

Parameter	Type
gdbVersion	string

Returns 

void

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[]>

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.

Type declaration

function(): void

Returns 

void

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

Type declaration

function(): void

Returns 

void

The total records count depends on the current query

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

Returns 

Promise<DataSource>

Default dataSource is the current data source. Default useDataSourceQueryParams is true, that is to say apply the data source's query params to the created ArcGIS Maps SDK for JavaScript layer by default. Default throwError is false, that is to say the method won't throw error and will return undefined if the creation fail.

Type declaration

function(dataSource?: DataSource, useDataSourceQueryParams?: boolean, throwError?: boolean): Promise<Layer>

Parameters

Parameter	Type
dataSource	DataSource
useDataSourceQueryParams	boolean
throwError	boolean

Returns 

Promise<Layer>

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

The data view ID configured in JSON.

Destroy the data source.

Type declaration

function(): void

Returns 

void

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>

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

Type declaration

function(): DataSource[]

Returns 

DataSource[]

Return the derived data views and local data sources.

Type declaration

function(): DataSource[]

Returns 

DataSource[]

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

Type declaration

function(jimuChildId: string): DataSource

Parameters

Parameter	Type
jimuChildId	string

Returns 

DataSource

Return child data sources of a parent data source.

Type declaration

function(): DataSource[]

Returns 

DataSource[]

Return data source count status.

Type declaration

function(): DataSourceStatus

Returns 

DataSourceStatus

The data source JSON object in app config.

Type declaration

function(): IMDataSourceJson

Returns 

IMDataSourceJson

Get data view by data view ID.

Type declaration

function(dataViewId: string): DataSource

Parameters

Parameter	Type
dataViewId	string

Returns 

DataSource

Return the config of the current data source.

Type declaration

function(): IMDataViewJson

Returns 

IMDataViewJson

Return all data views created from a main data source.

Type declaration

function(): DataSource[]

Returns 

DataSource[]

Get the service GDB version.

Type declaration

function(): string

Returns 

string

Return the data source ID field.

Type declaration

function(): string

Returns 

string

Return the data source info in redux store.

Type declaration

function(): IMDataSourceInfo

Returns 

IMDataSourceInfo

Return data source label.

Type declaration

function(): string

Returns 

string

Return whether listen selection.

Type declaration

function(): boolean

Returns 

boolean

Get local data source by local ID.

Type declaration

function(localId: string): DataSource

Parameters

Parameter	Type
localId	string

Returns 

DataSource

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

Type declaration

function(): DataSource[]

Returns 

DataSource[]

Return the main data source.

Type declaration

function(): DataSource

Returns 

DataSource

Get record by index

Type declaration

function(index: number): DataRecord

Parameters

Parameter	Type
index	number

Returns 

DataRecord

Get record by ID

Type declaration

function(id: string): DataRecord

Parameters

Parameter	Type
id	string

Returns 

DataRecord

Get records

Type declaration

function(): DataRecord[]

Returns 

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[]

Return the root data source.

Type declaration

function(): DataSource

Returns 

DataSource

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.

Type declaration

function(): IMDataSourceSchema

Returns 

IMDataSourceSchema

Get selected record IDs

Type declaration

function(): string[]

Returns 

string[]

Get selected record indexes

Type declaration

function(): number[]

Returns 

number[]

Get selected records

Type declaration

function(): DataRecord[]

Returns 

DataRecord[]

Return the source records

Type declaration

function(): DataRecord[]

Returns 

DataRecord[]

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

Type declaration

function(): number

Returns 

number

Return data source status.

Type declaration

function(): DataSourceStatus

Returns 

DataSourceStatus

Return data source version.

Type declaration

function(): number

Returns 

number

The data source ID.

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 .

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.

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

Type declaration

function(): boolean

Returns 

boolean

True means the data source is a local data source.

1 How to use ArcGIS Maps SDK for JavaScript layer 1.1 a data source may have a layer, the layer is the source of the data source ( isDataInDataSourceInstance should be false) and is used to save source data and communicate with Maps SDK for JavaScript (get popupTemplate, symbol and so on), if want to query features, should use data source instance, not the layer. 1.2 main data source and all other data views/local data source share the same layer. 1.3 selection view create a new layer when do query, but doesn't save the layer. 1.4 if widget needs an ArcGIS Maps SDK for JavaScript layer, call dataSource.createJSAPILayerByDataSource() to create a new layer, do not use the layer in data source instance directly, to listen data source changes and apply the changes to the new layer, see 2.2.

2 How to listen data source changes via DataSourceComponent 2.1 if widget loads records, use onDataSourceInfoChange to listen selected records change, query params change and loaded records change. 2.2 if widget doesn't load records (use a Maps SDK for JavaScript widget and needs an ArcGIS Maps SDK for JavaScript layer), use onQueryRequired to listen query params change, use onSelectionChange to listen selected records change.

3 Relation between output data source and origin data source 3.1 if schema is not changed (e.g. query output) and only has one origin data source, will use origin data source's layerDefinition , popupInfo and Maps SDK for JavaScript layer . 3.2 if schema is changed (e.g. chart output), need widget to set layerDefinition , popupInfo and Maps SDK for JavaScript layer to data source instance.

The local ID of the data source.

Order in the parent data source.

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

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>

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.

Type declaration

function(id: string, record?: DataRecord): void

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

Select records.

Type declaration

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

Parameters

Parameter	Type
options	SelectOptions

Returns 

Promise<Pick<QueryResult, "records">>

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.

Type declaration

function(ids: string[], records?: DataRecord[]): void

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

Update data source count status.

Type declaration

function(status: DataSourceStatus): void

Parameters

Parameter	Type
status	DataSourceStatus

Returns 

void

Update data source JSON in data source instance

Type declaration

function(dsJson: IMDataSourceJson): void

Parameters

Parameter	Type
dsJson	IMDataSourceJson

Returns 

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.

Type declaration

function(listen: boolean): void

Parameters

Parameter	Type
listen	boolean

Returns 

void

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

Type declaration

function(records: DataRecord[]): void

Parameters

Parameter	Type
records	DataRecord[]

Returns 

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.

Type declaration

function(records: DataRecord[]): void

Parameters

Parameter	Type
records	DataRecord[]

Returns 

void

Update data source status.

Type declaration

function(status: DataSourceStatus): void

Parameters

Parameter	Type
status	DataSourceStatus

Returns 

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.

Type declaration

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

Parameters

Parameter	Type
options	SelectOptions
triggerDataSource	DataSource
forceCheck	boolean

Returns 

void