SceneServiceDataSource
Interface
SceneServiceDataSource is created from scene service or webscene.
Properties
| Property | Type | Notes |
|---|---|---|
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 | |
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. | |
Layer | ArcGISSubLayer | 1 How to use ArcGIS Maps SDK for JavaScript layer
1.1 a data source may have a layer, the layer is only used to communicate with Maps SDK for JavaScript (get popupTemplate, symbol and so on), if want to query features, should use data source instance.
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 | |
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. | ||
SceneService | The type of the data source |
count
count: numberThe total records count depends on the current query
dataViewId
dataViewId: stringThe data view ID configured in Json.
isDataSourceSet
isDataSourceSet: booleanWhether a data source contains child data sources.
A dataset data source should create all its child data sources before ready() is resolved.
isDataView
isDataView: 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.
isLocal
isLocal: booleanTrue means the data source is a local data source.
layer
layer: Layer | ArcGISSubLayer1 How to use ArcGIS Maps SDK for JavaScript layer
1.1 a data source may have a layer, the layer is only used to communicate with Maps SDK for JavaScript (get popupTemplate, symbol and so on), if want to query features, should use data source instance.
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 data source.createJSAPILayerByDataSource() to create a new layer, do not use layer in data source instance directly, to apply data source 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.
localId
localId: stringThe local ID of the data source.
order
order: numberOrder in the parent data source.
parentDataSource
parentDataSource: DataSourceThe parent data source of this data source, mull means it's a root data source.
Methods
| Method | Returns | Notes |
|---|---|---|
void | When current data source is created from an array of records, it will be saved in | |
void | Update data source version. | |
buildRecord(data) | Builds a data record only -- does not add the record into data source. | |
changeGDBVersion(gdbVersion) | void | Change the GDB version for all layers in the service. |
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. | |
Promise<IMDataSourceSchema> | 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 | |
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 | Get the service GDB version. | |
string | Return the data source ID field. | |
getInfo() | IMDataSourceInfo | Return the data source info in redux store. |
getLabel() | string | Return data source label. |
boolean | Return whether listen selection. | |
getLocalDataSource(localId) | 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 | |
getRecordById(id) | 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 | |
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. | |
ready() | 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 |
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 |
setCountStatus(status) | void | Update data source count status. |
setDataSourceJson(dsJson) | void | Update data source JSON in data source instance |
setListenSelection(listen) | 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 |
setSourceRecords(records) | void | When current data source is created from an array of records, will save it in |
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 |
addSourceVersion
addSourceVersion(): 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.
Returns
voidaddVersion
addVersion(): voidUpdate data source version.
Returns
voidbuildRecord
buildRecord(data: any): DataRecordBuilds a data record only -- does not add the record into data source.
Parameters
| Parameter | Type |
|---|---|
data | any |
Returns
DataRecordchangeGDBVersion
changeGDBVersion(gdbVersion: string): voidChange the GDB version for all layers in the service.
Parameters
| Parameter | Type |
|---|---|
gdb | string |
Returns
voidclearRecords
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.
Returns
voidclearSourceRecords
clearSourceRecords(): voidClear both sourceRecords and loaded records. Both source version and version in data source info will be updated.
Returns
voidfetchSchema
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
getAllChildDataSources(): DataSource[]Return all child data sources of a parent data source, includes the grandchildren
Returns
DataSource[]getAllDerivedDataSources
getAllDerivedDataSources(): DataSource[]Return the derived data views and local data sources.
Returns
DataSource[]getChildDataSource
getChildDataSource(jimuChildId: string): DataSourceGet child data source by jimuChildId. You can get jimuChildId by getJimuChildId().
Parameters
| Parameter | Type |
|---|---|
jimu | string |
Returns
DataSourcegetChildDataSources
getChildDataSources(): DataSource[]Return child data sources of a parent data source.
Returns
DataSource[]getCountStatus
getCountStatus(): DataSourceStatusReturn data source count status.
Returns
DataSourceStatusgetDataSourceJson
getDataSourceJson(): IMDataSourceJsonThe data source JSON object in app config.
Returns
IMDataSourceJsongetDataView
getDataView(dataViewId: string): DataSourceGet data view by data view ID.
Parameters
| Parameter | Type |
|---|---|
data | string |
Returns
DataSourcegetDataViews
getDataViews(): DataSource[]Return all data views created from a main data source.
Returns
DataSource[]getGDBVersion
getGDBVersion(): stringGet the service GDB version.
Returns
stringgetIdField
getIdField(): stringReturn the data source ID field.
Returns
stringgetInfo
getInfo(): IMDataSourceInfoReturn the data source info in redux store.
Returns
IMDataSourceInfogetLabel
getLabel(): stringReturn data source label.
Returns
stringgetListenSelection
getListenSelection(): booleanReturn whether listen selection.
Returns
booleangetLocalDataSource
getLocalDataSource(localId: string): DataSourceGet local data source by local ID.
Parameters
| Parameter | Type |
|---|---|
local | string |
Returns
DataSourcegetLocalDataSources
getLocalDataSources(): DataSource[]Return all local data sources created from a main data source or data view.
Returns
DataSource[]getMainDataSource
getMainDataSource(): DataSourceReturn the main data source.
Returns
DataSourcegetRecord
getRecord(index: number): DataRecordGet record by index
Parameters
| Parameter | Type |
|---|---|
index | number |
Returns
DataRecordgetRecordById
getRecordById(id: string): DataRecordGet record by ID
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
DataRecordgetRecords
getRecords(): DataRecord[]Get records
Returns
DataRecord[]getRecordsWithSelection
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
getRootDataSource(): DataSourceReturn the root data source.
Returns
DataSourcegetSchema
getSchema(): IMDataSourceSchemaThe schema returned here is the merged result of the configured schema and the fetched schema.
Returns
IMDataSourceSchemagetSelectedRecordIds
getSelectedRecordIds(): string[]Get selected record IDs
Returns
string[]getSelectedRecordIndexes
getSelectedRecordIndexes(): number[]Get selected record indexes
Returns
number[]getSelectedRecords
getSelectedRecords(): DataRecord[]Get selected records
Returns
DataRecord[]getSourceRecords
getSourceRecords(): DataRecord[]Return the source records
Returns
DataRecord[]getSourceVersion
getSourceVersion(): numberWhen current data source is created from an array of records, it will be saved in sourceRecords.
Return the version of sourceRecords.
Returns
numbergetStatus
getStatus(): DataSourceStatusReturn data source status.
Returns
DataSourceStatusgetVersion
getVersion(): numberReturn data source version.
Returns
numberisInAppConfig
isInAppConfig(): booleanReturn whether the data source is added in builder and is saved in app config.
Returns
booleanready
ready(): 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): 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): 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): voidUpdate data source count status.
Parameters
| Parameter | Type |
|---|---|
status | DataSourceStatus |
Returns
voidsetDataSourceJson
setDataSourceJson(dsJson: IMDataSourceJson): voidUpdate data source JSON in data source instance
Parameters
| Parameter | Type |
|---|---|
d | IMDataSourceJson |
Returns
voidsetListenSelection
setListenSelection(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
setRecords(records: DataRecord[]): voidUpdate the records in the data source object only, does not update the source data. See DataSourceEditSourceOperations.updateRecords
Parameters
| Parameter | Type |
|---|---|
records | DataRecord[] |
Returns
voidsetSourceRecords
setSourceRecords(records: DataRecord[]): voidWhen 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
| Parameter | Type |
|---|---|
records | DataRecord[] |
Returns
voidsetStatus
setStatus(status: DataSourceStatus): voidUpdate data source status.
Parameters
| Parameter | Type |
|---|---|
status | DataSourceStatus |
Returns
voidupdateSelectionInfo
updateSelectionInfo(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
belongToDataSource: DataSourceThe data source which this data source derives from.