Interface
Interface for map related data sources. It contains a JS API Map instance.
Properties
| Property | Type | Notes |
|---|---|---|
addSourceVersioninherited | () => void | When current data source is created from an array of records, it will be saved in |
addVersioninherited | () => void | Update data source version. |
areChildDataSourcesCreatedinherited | () => 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 ( |
belongToDataSourceinherited | DataSource | The data source which this data source derives from. |
buildRecordinherited | (data: any) => DataRecord | Builds a data record only -- does not add the record into data source. |
childDataSourcesReady | () => 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 ( |
clearRecordsinherited | () => 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. |
clearSourceRecordsinherited | () => void | Clear both sourceRecords and loaded records. Both source version and version in data source info will be updated. |
countinherited | number | The total records count depends on the current query |
createDataSourceById | (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 ( |
dataSourceManagerinherited | DataSourceManager | The data source manager, which is used to manage the data source, including create/get/destroy the data source instance. |
dataViewIdinherited | string | The data view ID configured in JSON. |
destroyinherited | () => 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. |
getAllChildDataSourcesinherited | () => DataSource[] | Return all child data sources of a parent data source, includes the grandchildren |
getAllDerivedDataSourcesinherited | () => DataSource[] | Return the derived data views and local data sources. |
getChildDataSourceinherited | (jimuChildId: string) => DataSource | Get child data source by |
getChildDataSourceIdsinherited | () => string[] | Get child data source IDs, the child data sources may not be created by the time. |
getChildDataSourcesinherited | () => DataSource[] | Return child data sources of a parent data source. |
getCountStatusinherited | () => DataSourceStatus | Return data source count status. |
getDataSourceJsoninherited | () => IMDataSourceJson | The data source JSON object in app config. |
getDataViewinherited | (dataViewId: string) => DataSource | Get data view by data view ID. |
getDataViewConfiginherited | () => IMDataViewJson | Return the config of the current data source. |
getDataViewsinherited | () => DataSource[] | Return all data views created from a main data source. |
getIdFieldinherited | () => string | Return the data source ID field. |
getInfoinherited | () => IMDataSourceInfo | Return the data source info in redux store. |
getLabelinherited | () => string | Return data source label. |
getListenSelectioninherited | () => boolean | Return whether listen selection. |
getLocalDataSourceinherited | (localId: string) => DataSource | Get local data source by local ID. |
getLocalDataSourcesinherited | () => DataSource[] | Return all local data sources created from a main data source or data view. |
getMainDataSourceinherited | () => DataSource | Return the main data source. |
getRecordinherited | (index: number) => DataRecord | Get record by index |
getRecordByIdinherited | (id: string) => DataRecord | Get record by ID |
getRecordsinherited | () => DataRecord[] | Get records |
getRecordsWithSelectioninherited | () => 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. |
getRootDataSourceinherited | () => DataSource | Return the root data source. |
getSchemainherited | () => 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. |
getSelectedRecordIdsinherited | () => string[] | Get selected record IDs |
getSelectedRecordIndexesinherited | () => number[] | Get selected record indexes |
getSelectedRecordsinherited | () => DataRecord[] | Get selected records |
getSelectionDataViewinherited | () => DataSource | Get selection data view |
getSourceRecordsinherited | () => DataRecord[] | Return the source records |
getSourceVersioninherited | () => number | When current data source is created from an array of records, it will be saved in |
getStatusinherited | () => DataSourceStatus | Return data source status. |
getVersioninherited | () => number | Return data source version. |
idinherited | string | The data source ID. |
isDataSourceSetinherited | () => thisisDataSource & SetDataSourceMixin | Whether a data source contains child data sources.
A set data source won't create all its child data sources when |
isDataViewinherited | 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. |
isInAppConfiginherited | () => boolean | Return whether the data source is added in builder and is saved in app config. |
isLocalinherited | boolean | True means the data source is a local data source. |
isSelectionViewinherited | () => boolean | Determine whether the data source is a selection view. |
localIdinherited | string | The local ID of the data source. |
orderinherited | number | Order in the parent data source. |
parentDataSourceinherited | DataSource & SetDataSourceMixin | The parent data source of this data source, mull means it's a root data source. |
ready | () => Promise<void> | 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 |
selectRecordByIdinherited | (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. |
selectRecordsinherited | (options: SelectOptions) => Promise<Pick<QueryResult, "records">> | Select records. |
selectRecordsByIdsinherited | (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. |
setCountStatusinherited | (status: DataSourceStatus) => void | Update data source count status. |
setDataSourceJsoninherited | (dsJson: IMDataSourceJson) => void | Update data source JSON in data source instance |
setListenSelectioninherited | (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. |
setRecordsinherited | (records: DataRecord[]) => void | Update the records in the data source object only, does not update the source data. |
setSourceRecordsinherited | (records: DataRecord[]) => void | When current data source is created from an array of records, will save it in |
setStatusinherited | (status: DataSourceStatus) => void | Update data source status. |
type | Map | WebMap | WebScene | The type of the data source. |
updateSelectionInfoinherited | (options: SelectOptions, triggerDataSource: DataSource, forceCheck?: boolean) => void | Update selected records in data source info if the current data source listens selection change (see |