Interface
FeatureLayerDataSource
is created from a single feature layer of feature service, map service or webmap/webscene.
The source of feature layer data source may be from -
- an array directly (
sourceRecords
),isDataInDataSourceInstance
is true for such data sources, or, - an ArcGIS Maps SDK for JavaScript feature layer, or,
- an AGOL/portal item or a remote database.
Please note, for the 2, the feature layer can be both client-side or server-side.
Properties
Property | Type | Notes |
---|---|---|
addSourceVersion inherited | () => void | When current data source is created from an array of records, it will be saved in |
addVersion inherited | () => void | Update data source version. |
areChildDataSourcesCreated inherited | () => 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 ( |
belongToDataSource inherited | The data source which this data source derives from. | |
childDataSourcesReady inherited | () => 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 ( |
clearRecords inherited | () => 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 inherited | () => void | Clear both sourceRecords and loaded records. Both source version and version in data source info will be updated. |
count inherited | number | The total records count depends on the current query |
createDataSourceById inherited | (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 ( |
createJSAPILayerByDataSource inherited | (dataSource?: DataSource, useDataSourceQueryParams?: boolean, throwError?: boolean) => Promise<Layer> | Default |
dataSourceManager inherited | The data source manager, which is used to manage the data source, including create/get/destroy the data source instance. | |
dataViewId inherited | string | The data view ID configured in JSON. |
destroy inherited | () => void | Destroy the data source. |
getAllChildDataSources inherited | () => DataSource[] | Return all child data sources of a parent data source, includes the grandchildren |
getAllDerivedDataSources inherited | () => DataSource[] | Return the derived data views and local data sources. |
getAllLoadedRecords inherited | () => DataRecord[] | Get records of all the loaded pages. |
getAutoRefreshInterval inherited | () => number | If the return value > 0, auto refresh is enabled. |
getChildDataSource inherited | (jimuChildId: string) => DataSource | Get child data source by |
getChildDataSources inherited | () => DataSource[] | Return child data sources of a parent data source. |
getCountStatus inherited | () => DataSourceStatus | Return data source count status. |
getCurrentQueryId inherited | () => string | Get the current loaded record id, which is used in |
getDataSourceJson inherited | () => IMDataSourceJson | The data source JSON object in app config. |
getDataViewConfig inherited | () => IMDataViewJson | Return the config of the current data source. |
getInfo inherited | () => IMDataSourceInfo | Return the data source info in redux store. |
getLabel inherited | () => string | Return data source label. |
getListenSelection inherited | () => boolean | Return whether listen selection. |
getLocalDataSource inherited | (localId: string) => DataSource | Get local data source by local ID. |
getLocalDataSources inherited | () => DataSource[] | Return all local data sources created from a main data source or data view. |
getMaxRecordCount inherited | () => number | Null means there is no record count limit, and will return all records from the service. |
getRealQueryPages inherited | (pageSize: number, page: number) => number[] | Get real query page depends on the widget's request page. |
getRecord inherited | (index: number) => DataRecord | Get record by index |
getRecordById inherited | (id: string) => DataRecord | Get record by ID |
getRecords inherited | () => DataRecord[] | Get records of the loaded continuous pages. If the loaded pages are 1, 2, and 10, will only return records on the page 1 and 2. |
getRecordsByPage inherited | (page: number, pageSize: number) => DataRecord[] | The page size here defines the records this method returns, which are not the actual query pageSize. Will use a fixed pageSize to query and cache data. |
getRecordsByPageWithSelection inherited | (page: number, pageSize: number) => DataRecord[] | If selected records are not loaded in the current data source, will concat them to the end of records array. See getRecordsWithSelection for details. |
getRecordsWithSelection inherited | () => 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. |
getRemoteQueryParams inherited | () => QueryParams | Get the query parameters configured in remote (not in exb). |
getRootDataSource inherited | () => DataSource | Return the root data source. |
getRuntimeQueryParams inherited | (excludeWidgetId?: string) => QueryParams | Get the queries applied in runtime. If the excludeWidgetId is passed in, the queries of this widget will be excluded. |
getSchema inherited | () => 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 inherited | () => string[] | Get selected record IDs |
getSelectedRecordIndexes inherited | () => number[] | Get selected record indexes |
getSelectedRecords inherited | () => DataRecord[] | Get selected records |
getSourceVersion inherited | () => number | When current data source is created from an array of records, it will be saved in |
getStatus inherited | () => DataSourceStatus | Return data source status. |
getVersion inherited | () => number | Return data source version. |
id inherited | string | The data source ID. |
isDataSourceSet inherited | boolean | Whether a data source contains child data sources.
A set data source won't create all its child data sources when |
isDataView inherited | 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 inherited | () => boolean | Return whether the data source is added in builder and is saved in app config. |
isLocal inherited | boolean | True means the data source is a local data source. |
isSqlCaseSensitive inherited | boolean | Whether the data source is case-sensitive when doing query by SQL clauses. |
FeatureLayer | The ArcGIS Maps SDK for JavaScript FeatureLayer object. | |
loadById inherited | (id: string, refresh?: boolean) => Promise<DataRecord> | Load record by ID, do not consider other queries. |
localId inherited | string | The local ID of the data source. |
order inherited | number | Order in the parent data source. |
parentDataSource inherited | The parent data source of this data source, mull means it's a root data source. | |
queryAll inherited | (query: QueryParams, signal?: AbortSignal, progressCallback?: QueryProgressCallback, options?: QueryOptions) => Promise<QueryResult> | Query all records, there is no limit to the number of the records returned in the |
queryById inherited | (id: string, fields?: string[]) => Promise<DataRecord> | Query record by ID.
Will return all fields if not pass in the |
queryIds inherited | (query: QueryParams, options?: QueryOptions) => Promise<QueryResult> | Query record IDs, there is no limit to the number of the IDs returned in the |
ready inherited | () => 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 |
The Feature Layer JSON object. | ||
setCountStatus inherited | (status: DataSourceStatus) => void | Update data source count status. |
setDataSourceJson inherited | (dsJson: IMDataSourceJson) => void | Update data source JSON in data source instance |
setListenSelection inherited | (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 inherited | (records: DataRecord[]) => void | Update the records in the data source object only, does not update the source data. |
setStatus inherited | (status: DataSourceStatus) => void | Update data source status. |
updateQueryParams inherited | (query: QueryParams, widgetId: string) => void | Update the data source query without executing the actual query. |
updateSelectionInfo inherited | (options: SelectOptions, triggerDataSource: DataSource, forceCheck?: boolean) => void | Update selected records in data source info if the current data source listens selection change (see |
addSourceVersion
addSourceVersion: () => 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.
Type declaration
function(): void
Returns
void
addVersion
addVersion: () => void
Update data source version.
Type declaration
function(): void
Returns
void
areChildDataSourcesCreated
areChildDataSourcesCreated: () => 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).
Type declaration
function(): boolean
Returns
boolean
belongToDataSource
belongToDataSource: DataSource
The data source which this data source derives from.
childDataSourcesReady
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 ( dataSource.isDataSourceSet
is true).
Type declaration
function(): Promise<DataSource[]>
Returns
Promise<DataSource[]>
clearRecords
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.
Type declaration
function(): void
Returns
void
clearSourceRecords
clearSourceRecords: () => 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
count
count: number
The total records count depends on the current query
createDataSourceById
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 ( 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 |
---|---|
data | string |
Returns
Promise<DataSource>
createJSAPILayerByDataSource
createJSAPILayerByDataSource: (dataSource?: DataSource, useDataSourceQueryParams?: boolean, throwError?: boolean) => Promise<Layer>
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 |
---|---|
data | DataSource |
use | boolean |
throw | boolean |
Returns
Promise<Layer>
dataSourceManager
dataSourceManager: DataSourceManager
The data source manager, which is used to manage the data source, including create/get/destroy the data source instance.
dataViewId
dataViewId: string
The data view ID configured in JSON.
destroy
destroy: () => void
Destroy the data source.
Type declaration
function(): void
Returns
void
getAllChildDataSources
getAllChildDataSources: () => DataSource[]
Return all child data sources of a parent data source, includes the grandchildren
Type declaration
function(): DataSource[]
Returns
DataSource[]
getAllDerivedDataSources
getAllDerivedDataSources: () => DataSource[]
Return the derived data views and local data sources.
Type declaration
function(): DataSource[]
Returns
DataSource[]
getAllLoadedRecords
getAllLoadedRecords: () => DataRecord[]
Get records of all the loaded pages.
Type declaration
function(): DataRecord[]
Returns
DataRecord[]
getAutoRefreshInterval
getAutoRefreshInterval: () => number
If the return value > 0, auto refresh is enabled.
Type declaration
function(): number
Returns
number
getChildDataSource
getChildDataSource: (jimuChildId: string) => DataSource
Get child data source by jimuChildId
. You can get jimuChildId
by getJimuChildId()
.
Type declaration
function(jimuChildId: string): DataSource
Parameters
Parameter | Type |
---|---|
jimu | string |
Returns
DataSource
getChildDataSources
getChildDataSources: () => DataSource[]
Return child data sources of a parent data source.
Type declaration
function(): DataSource[]
Returns
DataSource[]
getCountStatus
getCountStatus: () => DataSourceStatus
Return data source count status.
Type declaration
function(): DataSourceStatus
Returns
DataSourceStatus
getCurrentQueryId
getCurrentQueryId: () => string
Get the current loaded record id, which is used in loadById
method.
Type declaration
function(): string
Returns
string
getDataSourceJson
getDataSourceJson: () => IMDataSourceJson
The data source JSON object in app config.
Type declaration
function(): IMDataSourceJson
Returns
IMDataSourceJson
getDataViewConfig
getDataViewConfig: () => IMDataViewJson
Return the config of the current data source.
Type declaration
function(): IMDataViewJson
Returns
IMDataViewJson
getInfo
getInfo: () => IMDataSourceInfo
Return the data source info in redux store.
Type declaration
function(): IMDataSourceInfo
Returns
IMDataSourceInfo
getLabel
getLabel: () => string
Return data source label.
Type declaration
function(): string
Returns
string
getListenSelection
getListenSelection: () => boolean
Return whether listen selection.
Type declaration
function(): boolean
Returns
boolean
getLocalDataSource
getLocalDataSource: (localId: string) => DataSource
Get local data source by local ID.
Type declaration
function(localId: string): DataSource
Parameters
Parameter | Type |
---|---|
local | string |
Returns
DataSource
getLocalDataSources
getLocalDataSources: () => DataSource[]
Return all local data sources created from a main data source or data view.
Type declaration
function(): DataSource[]
Returns
DataSource[]
getMaxRecordCount
getMaxRecordCount: () => number
Null means there is no record count limit, and will return all records from the service.
Type declaration
function(): number
Returns
number
getRealQueryPages
getRealQueryPages: (pageSize: number, page: number) => number[]
Get real query page depends on the widget's request page.
Type declaration
function(pageSize: number, page: number): number[]
Parameters
Parameter | Type |
---|---|
page | number |
page | number |
Returns
number[]
getRecord
getRecord: (index: number) => DataRecord
Get record by index
Type declaration
function(index: number): DataRecord
Parameters
Parameter | Type |
---|---|
index | number |
Returns
DataRecord
getRecordById
getRecordById: (id: string) => DataRecord
Get record by ID
Type declaration
function(id: string): DataRecord
Parameters
Parameter | Type |
---|---|
id | string |
Returns
DataRecord
getRecords
getRecords: () => DataRecord[]
Get records of the loaded continuous pages. If the loaded pages are 1, 2, and 10, will only return records on the page 1 and 2.
Widgets can use different page sizes to query the data source, but the data source has a specific page size to query the service. The data source will save the loaded records by its own page size and split them when widgets doing queries (with different page and page sizes). The method returns continuous page records to make sure the order of the records is correct.
Type declaration
function(): DataRecord[]
Returns
DataRecord[]
getRecordsByPage
getRecordsByPage: (page: number, pageSize: number) => DataRecord[]
The page size here defines the records this method returns, which are not the actual query pageSize. Will use a fixed pageSize to query and cache data.
Type declaration
function(page: number, pageSize: number): DataRecord[]
Parameters
Parameter | Type |
---|---|
page | number |
page | number |
Returns
DataRecord[]
getRecordsByPageWithSelection
getRecordsByPageWithSelection: (page: number, pageSize: number) => DataRecord[]
If selected records are not loaded in the current data source, will concat them to the end of records array. See getRecordsWithSelection for details.
Type declaration
function(page: number, pageSize: number): DataRecord[]
Parameters
Parameter | Type |
---|---|
page | number |
page | number |
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.
Type declaration
function(): DataRecord[]
Returns
DataRecord[]
getRemoteQueryParams
getRemoteQueryParams: () => QueryParams
Get the query parameters configured in remote (not in exb).
Type declaration
function(): QueryParams
Returns
QueryParams
getRootDataSource
getRootDataSource: () => DataSource
Return the root data source.
Type declaration
function(): DataSource
Returns
DataSource
getRuntimeQueryParams
getRuntimeQueryParams: (excludeWidgetId?: string) => QueryParams
Get the queries applied in runtime. If the excludeWidgetId is passed in, the queries of this widget will be excluded.
Type declaration
function(excludeWidgetId?: string): QueryParams
Parameters
Parameter | Type |
---|---|
exclude | string |
Returns
QueryParams
getSchema
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.
Type declaration
function(): IMDataSourceSchema
Returns
IMDataSourceSchema
getSelectedRecordIds
getSelectedRecordIds: () => string[]
Get selected record IDs
Type declaration
function(): string[]
Returns
string[]
getSelectedRecordIndexes
getSelectedRecordIndexes: () => number[]
Get selected record indexes
Type declaration
function(): number[]
Returns
number[]
getSelectedRecords
getSelectedRecords: () => DataRecord[]
Get selected records
Type declaration
function(): DataRecord[]
Returns
DataRecord[]
getSourceVersion
getSourceVersion: () => number
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
getStatus
getStatus: () => DataSourceStatus
Return data source status.
Type declaration
function(): DataSourceStatus
Returns
DataSourceStatus
getVersion
getVersion: () => number
Return data source version.
Type declaration
function(): number
Returns
number
id
id: string
The data source ID.
isDataSourceSet
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
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
isInAppConfig: () => boolean
Return whether the data source is added in builder and is saved in app config.
Type declaration
function(): boolean
Returns
boolean
isLocal
isLocal: boolean
True means the data source is a local data source.
isSqlCaseSensitive
isSqlCaseSensitive: boolean
Whether the data source is case-sensitive when doing query by SQL clauses.
layer
layer: FeatureLayer
The ArcGIS Maps SDK for JavaScript FeatureLayer object.
loadById
loadById: (id: string, refresh?: boolean) => Promise<DataRecord>
Load record by ID, do not consider other queries.
Type declaration
function(id: string, refresh?: boolean): Promise<DataRecord>
Parameters
Parameter | Type |
---|---|
id | string |
refresh | boolean |
Returns
Promise<DataRecord>
localId
localId: string
The local ID of the data source.
order
order: number
Order in the parent data source.
parentDataSource
parentDataSource: DataSource
The parent data source of this data source, mull means it's a root data source.
queryAll
queryAll: (query: QueryParams, signal?: AbortSignal, progressCallback?: QueryProgressCallback, options?: QueryOptions) => Promise<QueryResult>
Query all records, there is no limit to the number of the records returned in the records
array response.
You can abort the progress by a abort signal
and can use progressCallback
to get the progress and the current results.
Type declaration
function(query: QueryParams, signal?: AbortSignal, progressCallback?: QueryProgressCallback, options?: QueryOptions): Promise<QueryResult>
Parameters
Parameter | Type |
---|---|
query | QueryParams |
signal | AbortSignal |
progress | QueryProgressCallback |
options | QueryOptions |
Returns
Promise<QueryResult>
queryById
queryById: (id: string, fields?: string[]) => Promise<DataRecord>
Query record by ID.
Will return all fields if not pass in the fields
.
Type declaration
function(id: string, fields?: string[]): Promise<DataRecord>
Parameters
Parameter | Type |
---|---|
id | string |
fields | string[] |
Returns
Promise<DataRecord>
queryIds
queryIds: (query: QueryParams, options?: QueryOptions) => Promise<QueryResult>
Query record IDs, there is no limit to the number of the IDs returned in the ids
array response.
Type declaration
function(query: QueryParams, options?: QueryOptions): Promise<QueryResult>
Parameters
Parameter | Type |
---|---|
query | QueryParams |
options | QueryOptions |
Returns
Promise<QueryResult>
ready
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 childDataSourcesReady
.
Type declaration
function(): Promise<any>
Returns
Promise<any>
restLayer
restLayer: IFeatureLayer
The Feature Layer JSON object.
setCountStatus
setCountStatus: (status: DataSourceStatus) => void
Update data source count status.
Type declaration
function(status: DataSourceStatus): void
Parameters
Parameter | Type |
---|---|
status | DataSourceStatus |
Returns
void
setDataSourceJson
setDataSourceJson: (dsJson: IMDataSourceJson) => void
Update data source JSON in data source instance
Type declaration
function(dsJson: IMDataSourceJson): void
Parameters
Parameter | Type |
---|---|
ds | IMDataSourceJson |
Returns
void
setListenSelection
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.
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
setRecords
setRecords: (records: DataRecord[]) => 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
setStatus
setStatus: (status: DataSourceStatus) => void
Update data source status.
Type declaration
function(status: DataSourceStatus): void
Parameters
Parameter | Type |
---|---|
status | DataSourceStatus |
Returns
void
updateQueryParams
updateQueryParams: (query: QueryParams, widgetId: string) => void
Update the data source query without executing the actual query.
Type declaration
function(query: QueryParams, widgetId: string): void
Parameters
Parameter | Type |
---|---|
query | QueryParams |
widget | string |
Returns
void
updateSelectionInfo
updateSelectionInfo: (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.
Type declaration
function(options: SelectOptions, triggerDataSource: DataSource, forceCheck?: boolean): void
Parameters
Parameter | Type |
---|---|
options | SelectOptions |
trigger | DataSource |
force | boolean |
Returns
void