ArcGISQueriableDataSource

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.

Update data source version.

The data source which this data source derives from.

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

Change the layer GDB version.

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.

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

The total records count depends on the current query

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.

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.

Fetch the data schema from an actual data source. If it's a statistic data source, the schema will not be fetched.

Return the derived data views and local data sources.

Get records of all the loaded pages.

If the return value > 0, auto refresh is enabled.

Get the user config query parameters.

Return data source count status.

Get the current loaded record id, which is used in loadById method.

Get the current query parameters. The current query parameters contain all applied queries.

The data source JSON object in app config.

Return the config of the current data source.

Override parent interface to get correct type.

Return the current GDB version.

Return the data source ID field.

Return the data source info in redux store.

Return data source label.

Return whether listen selection.

Get local data source by local ID.

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

Null means there is no record count limit, and will return all records from the service.

Get real query page depends on the widget's request page.

When do query/load, we do not fire the query request directly. Instead, we'll consider the data source's config/current query parameter.

Get record by index

Get record by ID

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.

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.

If selected records are not loaded in the current data source, will concat them to the end of records array. See getRecordsWithSelection for details.

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.

Get the query parameters configured in remote (not in exb).

Return the root data source.

Get the queries applied in runtime. If the excludeWidgetId is passed in, the queries of this widget will be excluded.

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.

Get selected record IDs

Get selected record indexes

Get selected records

Get selection data view

Return the source records

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

Return data source status.

Return data source version.

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.

True means the data source is a local data source.

Determine whether the data source is a selection view.

Whether the data source is case-sensitive when doing query by SQL clauses.

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.

Execute the query against the service and update the internal data records, pagination is supported. When call this method, the real query is returned by getRealQueryParams .

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

Load record by ID, do not consider other queries.

Load the records count.

The local ID of the data source.

Merge queries by using AND , and return the merged result. If any query is undefined/null, it will be ignored.

Order in the parent data source.

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

Execute query against the service only, do NOT update the internal data records. The actual query parameters are generated by getRealQueryParams .

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.

Query record by ID. Will return all fields if not pass in the fields .

Query count

Query record IDs, there is no limit to the number of the IDs returned in the ids array response.

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 .

Select all loaded records.

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.

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.

Update data source count status.

Update data source JSON in data source instance

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.

When the auto refresh is turned on, and the data source needRefresh status is changed, this method will be invoked.

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

When current data source is created from an array of features (__esri.Graphic), will save it in an ArcGIS Maps SDK for JavaScript feature layer. This method is used to update the source data. Please note, use this method only when isDataInDataSourceInstance is not true.

When current data source is created from an array of records ( DataRecord ), will save it in sourceRecords . These two methods are used to update or get the source data. Please note, use these two methods only when isDataInDataSourceInstance is true.

Update data source status.

Whether supports to create replica. See https://developers.arcgis.com/rest/services-reference/enterprise/create-replica/.

The type of the data source.

Update the data source query without executing the actual query.

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

The data source URL