ArcGISQueriableDataSource

Interface

ArcGISQueriableDataSource is created from a single ArcGIS queriable layer, such as feature layer, imagery layer and subtype group layer.

Inheritance: ArcGISQueriableDataSourceQueriableDataSourceJSAPILayerMixinItemMixin

Subclasses: FeatureLayerDataSource, SceneLayerDataSource, ImageryLayerDataSource, OrientedImageryLayerDataSource, SubtypeGroupLayerDataSource, SubtypeSublayerDataSource

Properties

Hide inherited properties

Property	Type	Notes
`addSourceVersion` inherited	`() => 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.
`addVersion` inherited	`() => void`	Update data source version.
`belongToDataSource` inherited	`DataSource`	The data source which this data source derives from.
`buildRecord`	`(feature: IFeature \| Graphic) => FeatureDataRecord`	Builds a data record only -- does not add the record into data source.
`changeGDBVersion`	`(gdbVersion: string) => void`	Change the layer GDB version.
`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
`createJSAPILayerByDataSource` inherited	`(dataSource?: DataSource, useDataSourceQueryParams?: boolean, throwError?: boolean) => Promise<Layer \| ArcGISSubLayer>`	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.
`dataSourceManager` inherited	`DataSourceManager`	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.
`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.
`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.
`getConfigQueryParams`	`() => ArcGISQueryParams`	Get the user config query parameters.
`getCountStatus` inherited	`() => DataSourceStatus`	Return data source count status.
`getCurrentQueryId` inherited	`() => string`	Get the current loaded record id, which is used in `loadById` method.
`getCurrentQueryParams`	`(options?: GetCurrentQueryParamsOptions) => ArcGISQueryParams`	Get the current query parameters. The current query parameters contain all applied queries.
`getDataSourceJson` inherited	`() => IMDataSourceJson`	The data source JSON object in app config.
`getDataViewConfig` inherited	`() => IMDataViewJson`	Return the config of the current data source.
`getDataViews`	`() => ArcGISQueriableDataSource[]`	Override parent interface to get correct type.
`getGDBVersion`	`() => string`	Return the current GDB version.
`getIdField`	`() => string`	Return the data source ID field.
`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.
`getRealQueryParams`	`(query: any, flag: "load" \| "query", options?: QueryOptions) => ArcGISQueryParams`	When do query/load, we do not fire the query request directly. Instead, we'll consider the data source's config/current query parameter.
`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
`getSelectionDataView` inherited	`() => DataSource`	Get selection data view
`getSourceRecords`	`() => DataRecord[]`	Return the source records
`getSourceVersion` inherited	`() => number`	When current data source is created from an array of records, it will be saved in `sourceRecords` . Return the version of `sourceRecords` .
`getStatus` inherited	`() => DataSourceStatus`	Return data source status.
`getVersion` inherited	`() => number`	Return data source version.
`id` inherited	`string`	The data source ID.
`isDataSourceSet` inherited	`() => thisisDataSource & SetDataSourceMixin`	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` 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.
`layer`	`ArcGISQueriableLayerTypes`	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.
`load`	`(query: ArcGISQueryParams, options?: QueryOptions) => Promise<DataRecord[]>`	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` .
`loadAll` inherited	`(query: QueryParams, signal?: AbortSignal, progressCallback?: QueryProgressCallback, options?: QueryOptions) => Promise<DataRecord[]>`	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.
`loadById` inherited	`(id: string, refresh?: boolean) => Promise<DataRecord>`	Load record by ID, do not consider other queries.
`loadCount`	`(query: ArcGISQueryParams, options?: QueryOptions) => Promise<number>`	Load the records count.
`localId` inherited	`string`	The local ID of the data source.
`mergeQueryParams`	`(queries: ArcGISQueryParams[]) => ArcGISQueryParams`	Merge queries by using `AND` , and return the merged result. If any query is undefined/null, it will be ignored.
`order` inherited	`number`	Order in the parent data source.
`parentDataSource` inherited	`DataSource & SetDataSourceMixin`	The parent data source of this data source, mull means it's a root data source.
`query`	`(query: ArcGISQueryParams, options?: QueryOptions) => Promise<QueryResult>`	Execute query against the service only, do NOT update the internal data records. The actual query parameters are generated by `getRealQueryParams` .
`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 `records` array response. You can abort the progress by a abort `signal` and can use `progressCallback` to get the progress and the current results.
`queryById` inherited	`(id: string, fields?: string[]) => Promise<DataRecord>`	Query record by ID. Will return all fields if not pass in the `fields` .
`queryCount`	`(query: ArcGISQueryParams, options?: QueryOptions) => Promise<QueryResult>`	Query count
`queryIds`	`(query: ArcGISQueryParams, options?: QueryOptions) => Promise<QueryResult>`	Query record IDs, there is no limit to the number of the IDs returned in the `ids` array response.
`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 `childDataSourcesReady` .
`selectAllLoadedRecords` inherited	`() => void`	Select all loaded records.
`selectRecordById`	`(id: string, record?: FeatureDataRecord) => 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.
`selectRecordsByIds`	`(ids: string[], records?: FeatureDataRecord[]) => 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.
`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.
`setSourceFeatures`	`(features: Graphic \| GraphicProperties[], others?: Omit<FeatureLayerProperties, "source" \| "fields" \| "objectIdField">) => Promise<void>`	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.
`setSourceRecords`	`(records: DataRecord[]) => void`	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.
`setStatus` inherited	`(status: DataSourceStatus) => void`	Update data source status.
`type` inherited	`string`	The type of the data source.
`updateQueryParams`	`(query: ArcGISQueryParams, 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 `setListenSelection` ) or the current data source is the trigger data source (that is to say, select via it).
`url`	`string`	The data source URL

addSourceVersion

inheritedinherited

Interface Property

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

Inherited from QueriableDataSource.addSourceVersion

addVersion

optionalinheritedinherited

Interface Property

addVersion: () => void

Update data source version.

Type declaration

function(): void

Returns

void

Inherited from QueriableDataSource.addVersion

belongToDataSource

optionalinheritedinherited

Interface Property

belongToDataSource: DataSource

The data source which this data source derives from.

Inherited from QueriableDataSource.belongToDataSource

buildRecord

Interface Property

buildRecord: (feature: IFeature | Graphic) => FeatureDataRecord

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

Type declaration

function(feature: IFeature | Graphic): FeatureDataRecord

Parameters

Parameter	Type
`feature`	IFeature \| Graphic

Returns

FeatureDataRecord

changeGDBVersion

Interface Property

changeGDBVersion: (gdbVersion: string) => void

Change the layer GDB version.

Type declaration

function(gdbVersion: string): void

Parameters

Parameter	Type
`gdbVersion`	string

Returns

void

clearRecords

optionalinheritedinherited

Interface Property

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

Inherited from QueriableDataSource.clearRecords

clearSourceRecords

inheritedinherited

Interface Property

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

Inherited from QueriableDataSource.clearSourceRecords

count

optionalinheritedinherited

Interface Property

count: number

The total records count depends on the current query

Inherited from QueriableDataSource.count

createJSAPILayerByDataSource

inheritedinherited

Interface Property

createJSAPILayerByDataSource: (dataSource?: DataSource, useDataSourceQueryParams?: boolean, throwError?: boolean) => Promise<Layer | ArcGISSubLayer>

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 | ArcGISSubLayer>

Parameters

Parameter	Type
`dataSource`	DataSource
`useDataSourceQueryParams`	boolean
`throwError`	boolean

Returns

Promise<Layer | ArcGISSubLayer>

Inherited from JSAPILayerMixin.createJSAPILayerByDataSource

dataSourceManager

inheritedinherited

Interface Property

dataSourceManager: DataSourceManager

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

Inherited from QueriableDataSource.dataSourceManager

dataViewId

optionalinheritedinherited

Interface Property

dataViewId: string

The data view ID configured in JSON.

Inherited from QueriableDataSource.dataViewId

destroy

inheritedinherited

Interface Property

destroy: () => void

Destroy the data source.

Type declaration

function(): void

Returns

void

Inherited from QueriableDataSource.destroy

fetchSchema

Interface Property

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.

Type declaration

function(): Promise<IMDataSourceSchema>

Returns

Promise<IMDataSourceSchema>

getAllDerivedDataSources

inheritedinherited

Interface Property

getAllDerivedDataSources: () => DataSource[]

Return the derived data views and local data sources.

Type declaration

function(): DataSource[]

Returns

DataSource[]

Inherited from QueriableDataSource.getAllDerivedDataSources

getAllLoadedRecords

inheritedinherited

Interface Property

getAllLoadedRecords: () => DataRecord[]

Get records of all the loaded pages.

Type declaration

function(): DataRecord[]

Returns

DataRecord[]

Inherited from QueriableDataSource.getAllLoadedRecords

getAutoRefreshInterval

inheritedinherited

Interface Property

getAutoRefreshInterval: () => number

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

Type declaration

function(): number

Returns

number

Inherited from QueriableDataSource.getAutoRefreshInterval

getConfigQueryParams

Interface Property

getConfigQueryParams: () => ArcGISQueryParams

Get the user config query parameters.

Type declaration

function(): ArcGISQueryParams

Returns

ArcGISQueryParams

getCountStatus

inheritedinherited

Interface Property

getCountStatus: () => DataSourceStatus

Return data source count status.

Type declaration

function(): DataSourceStatus

Returns

DataSourceStatus

Inherited from QueriableDataSource.getCountStatus

getCurrentQueryId

inheritedinherited

Interface Property

getCurrentQueryId: () => string

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

Type declaration

function(): string

Returns

string

Inherited from QueriableDataSource.getCurrentQueryId

getCurrentQueryParams

Interface Property

getCurrentQueryParams: (options?: GetCurrentQueryParamsOptions) => ArcGISQueryParams

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

Type declaration

function(options?: GetCurrentQueryParamsOptions): ArcGISQueryParams

Parameters

Parameter	Type
`options`	GetCurrentQueryParamsOptions

Returns

ArcGISQueryParams

getDataSourceJson

inheritedinherited

Interface Property

getDataSourceJson: () => IMDataSourceJson

The data source JSON object in app config.

Type declaration

function(): IMDataSourceJson

Returns

IMDataSourceJson

Inherited from QueriableDataSource.getDataSourceJson

getDataViewConfig

inheritedinherited

Interface Property

getDataViewConfig: () => IMDataViewJson

Return the config of the current data source.

Type declaration

function(): IMDataViewJson

Returns

IMDataViewJson

Inherited from QueriableDataSource.getDataViewConfig

getDataViews

Interface Property

getDataViews: () => ArcGISQueriableDataSource[]

Override parent interface to get correct type.

Type declaration

function(): ArcGISQueriableDataSource[]

Returns

ArcGISQueriableDataSource[]

getGDBVersion

Interface Property

getGDBVersion: () => string

Return the current GDB version.

Type declaration

function(): string

Returns

string

getIdField

Interface Property

getIdField: () => string

Return the data source ID field.

Type declaration

function(): string

Returns

string

getInfo

inheritedinherited

Interface Property

getInfo: () => IMDataSourceInfo

Return the data source info in redux store.

Type declaration

function(): IMDataSourceInfo

Returns

IMDataSourceInfo

Inherited from QueriableDataSource.getInfo

getLabel

inheritedinherited

Interface Property

getLabel: () => string

Return data source label.

Type declaration

function(): string

Returns

string

Inherited from QueriableDataSource.getLabel

getListenSelection

inheritedinherited

Interface Property

getListenSelection: () => boolean

Return whether listen selection.

Type declaration

function(): boolean

Returns

boolean

Inherited from QueriableDataSource.getListenSelection

getLocalDataSource

inheritedinherited

Interface Property

getLocalDataSource: (localId: string) => DataSource

Get local data source by local ID.

Type declaration

function(localId: string): DataSource

Parameters

Parameter	Type
`localId`	string

Returns

DataSource

Inherited from QueriableDataSource.getLocalDataSource

getLocalDataSources

inheritedinherited

Interface Property

getLocalDataSources: () => DataSource[]

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

Type declaration

function(): DataSource[]

Returns

DataSource[]

Inherited from QueriableDataSource.getLocalDataSources

getMaxRecordCount

inheritedinherited

Interface Property

getMaxRecordCount: () => number

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

Type declaration

function(): number

Returns

number

Inherited from QueriableDataSource.getMaxRecordCount

getRealQueryPages

inheritedinherited

Interface Property

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
`pageSize`	number
`page`	number

Returns

number[]

Inherited from QueriableDataSource.getRealQueryPages

getRealQueryParams

Interface Property

getRealQueryParams: (query: any, flag: "load" | "query", options?: QueryOptions) => ArcGISQueryParams

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

For load: we'll merge the configured query parameter if it has, and all widget applied queries.
For query, we'll merge the current query parameter and the configured query parameter it has.

Type declaration

function(query: any, flag: "load" | "query", options?: QueryOptions): ArcGISQueryParams

Parameters

Parameter	Type
`query`	any
`flag`	"load" \| "query"
`options`	QueryOptions

Returns

ArcGISQueryParams

getRecord

inheritedinherited

Interface Property

getRecord: (index: number) => DataRecord

Get record by index

Type declaration

function(index: number): DataRecord

Parameters

Parameter	Type
`index`	number

Returns

DataRecord

Inherited from QueriableDataSource.getRecord

getRecordById

inheritedinherited

Interface Property

getRecordById: (id: string) => DataRecord

Get record by ID

Type declaration

function(id: string): DataRecord

Parameters

Parameter	Type
`id`	string

Returns

DataRecord

Inherited from QueriableDataSource.getRecordById

getRecords

inheritedinherited

Interface Property

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

Inherited from QueriableDataSource.getRecords

getRecordsByPage

inheritedinherited

Interface Property

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
`pageSize`	number

Returns

DataRecord[]

Inherited from QueriableDataSource.getRecordsByPage

getRecordsByPageWithSelection

inheritedinherited

Interface Property

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
`pageSize`	number

Returns

DataRecord[]

Inherited from QueriableDataSource.getRecordsByPageWithSelection

getRecordsWithSelection

inheritedinherited

Interface Property

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

Inherited from QueriableDataSource.getRecordsWithSelection

getRemoteQueryParams

inheritedinherited

Interface Property

getRemoteQueryParams: () => QueryParams

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

Type declaration

function(): QueryParams

Returns

QueryParams

Inherited from QueriableDataSource.getRemoteQueryParams

getRootDataSource

inheritedinherited

Interface Property

getRootDataSource: () => DataSource

Return the root data source.

Type declaration

function(): DataSource

Returns

DataSource

Inherited from QueriableDataSource.getRootDataSource

getRuntimeQueryParams

inheritedinherited

Interface Property

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
`excludeWidgetId`	string

Returns

QueryParams

Inherited from QueriableDataSource.getRuntimeQueryParams

getSchema

inheritedinherited

Interface Property

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

Inherited from QueriableDataSource.getSchema

getSelectedRecordIds

inheritedinherited

Interface Property

getSelectedRecordIds: () => string[]

Get selected record IDs

Type declaration

function(): string[]

Returns

string[]

Inherited from QueriableDataSource.getSelectedRecordIds

getSelectedRecordIndexes

inheritedinherited

Interface Property

getSelectedRecordIndexes: () => number[]

Get selected record indexes

Type declaration

function(): number[]

Returns

number[]

Inherited from QueriableDataSource.getSelectedRecordIndexes

getSelectedRecords

inheritedinherited

Interface Property

getSelectedRecords: () => DataRecord[]

Get selected records

Type declaration

function(): DataRecord[]

Returns

DataRecord[]

Inherited from QueriableDataSource.getSelectedRecords

getSelectionDataView

inheritedinherited

Interface Property

getSelectionDataView: () => DataSource

Get selection data view

Type declaration

function(): DataSource

Returns

DataSource

Inherited from QueriableDataSource.getSelectionDataView

getSourceRecords

Interface Property

getSourceRecords: () => DataRecord[]

Return the source records

Type declaration

function(): DataRecord[]

Returns

DataRecord[]

getSourceVersion

inheritedinherited

Interface Property

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

Inherited from QueriableDataSource.getSourceVersion

getStatus

inheritedinherited

Interface Property

getStatus: () => DataSourceStatus

Return data source status.

Type declaration

function(): DataSourceStatus

Returns

DataSourceStatus

Inherited from QueriableDataSource.getStatus

getVersion

inheritedinherited

Interface Property

getVersion: () => number

Return data source version.

Type declaration

function(): number

Returns

number

Inherited from QueriableDataSource.getVersion

id

inheritedinherited

Interface Property

id: string

The data source ID.

Inherited from QueriableDataSource.id

isDataSourceSet

inheritedinherited

Interface Property

isDataSourceSet: () => thisisDataSource & SetDataSourceMixin

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 .

Type declaration

function(): thisisDataSource & SetDataSourceMixin

Returns

thisisDataSource & SetDataSourceMixin

Inherited from QueriableDataSource.isDataSourceSet

isDataView

inheritedinherited

Interface Property

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.

Inherited from QueriableDataSource.isDataView

isInAppConfig

inheritedinherited

Interface Property

isInAppConfig: () => boolean

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

Type declaration

function(): boolean

Returns

boolean

Inherited from QueriableDataSource.isInAppConfig

isLocal

inheritedinherited

Interface Property

isLocal: boolean

True means the data source is a local data source.

Inherited from QueriableDataSource.isLocal

isSqlCaseSensitive

inheritedinherited

Interface Property

isSqlCaseSensitive: boolean

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

Inherited from QueriableDataSource.isSqlCaseSensitive

layer

optional

Interface Property

layer: ArcGISQueriableLayerTypes

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.

load

Interface Property

load: (query: ArcGISQueryParams, options?: QueryOptions) => Promise<DataRecord[]>

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 .

Pagination: The pagination properties in the passed in query parameter may be not the same as the real query pagination that is sent to the service. The real query pagination is defined in the data source setting.

Type declaration

function(query: ArcGISQueryParams, options?: QueryOptions): Promise<DataRecord[]>

Parameters

Parameter	Type
`query`	ArcGISQueryParams
`options`	QueryOptions

Returns

Promise<DataRecord[]>

loadAll

inheritedinherited

Interface Property

loadAll: (query: QueryParams, signal?: AbortSignal, progressCallback?: QueryProgressCallback, options?: QueryOptions) => Promise<DataRecord[]>

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.

Type declaration

function(query: QueryParams, signal?: AbortSignal, progressCallback?: QueryProgressCallback, options?: QueryOptions): Promise<DataRecord[]>

Parameters

Parameter	Type
`query`	QueryParams
`signal`	AbortSignal
`progressCallback`	QueryProgressCallback
`options`	QueryOptions

Returns

Promise<DataRecord[]>

Inherited from QueriableDataSource.loadAll

loadById

inheritedinherited

Interface Property

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>

Inherited from QueriableDataSource.loadById

loadCount

Interface Property

loadCount: (query: ArcGISQueryParams, options?: QueryOptions) => Promise<number>

Load the records count.

Type declaration

function(query: ArcGISQueryParams, options?: QueryOptions): Promise<number>

Parameters

Parameter	Type
`query`	ArcGISQueryParams
`options`	QueryOptions

Returns

Promise<number>

localId

optionalinheritedinherited

Interface Property

localId: string

The local ID of the data source.

Inherited from QueriableDataSource.localId

mergeQueryParams

Interface Property

mergeQueryParams: (queries: ArcGISQueryParams[]) => ArcGISQueryParams

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

Type declaration

function(queries: ArcGISQueryParams[]): ArcGISQueryParams

Parameters

Parameter	Type
`queries`	ArcGISQueryParams[]

Returns

ArcGISQueryParams

order

optionalinheritedinherited

Interface Property

order: number

Order in the parent data source.

Inherited from QueriableDataSource.order

parentDataSource

inheritedinherited

Interface Property

parentDataSource: DataSource & SetDataSourceMixin

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

Inherited from QueriableDataSource.parentDataSource

query

Interface Property

query: (query: ArcGISQueryParams, options?: QueryOptions) => Promise<QueryResult>

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

To query count, please use queryCount .

Type declaration

function(query: ArcGISQueryParams, options?: QueryOptions): Promise<QueryResult>

Parameters

Parameter	Type
`query`	ArcGISQueryParams
`options`	QueryOptions

Returns

Promise<QueryResult>

queryAll

inheritedinherited

Interface Property

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
`progressCallback`	QueryProgressCallback
`options`	QueryOptions

Returns

Promise<QueryResult>

Inherited from QueriableDataSource.queryAll

queryById

inheritedinherited

Interface Property

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>

Inherited from QueriableDataSource.queryById

queryCount

Interface Property

queryCount: (query: ArcGISQueryParams, options?: QueryOptions) => Promise<QueryResult>

Query count

Type declaration

function(query: ArcGISQueryParams, options?: QueryOptions): Promise<QueryResult>

Parameters

Parameter	Type
`query`	ArcGISQueryParams
`options`	QueryOptions

Returns

Promise<QueryResult>

queryIds

Interface Property

queryIds: (query: ArcGISQueryParams, 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: ArcGISQueryParams, options?: QueryOptions): Promise<QueryResult>

Parameters

Parameter	Type
`query`	ArcGISQueryParams
`options`	QueryOptions

Returns

Promise<QueryResult>

ready

inheritedinherited

Interface Property

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>

Inherited from QueriableDataSource.ready

selectAllLoadedRecords

inheritedinherited

Interface Property

selectAllLoadedRecords: () => void

Select all loaded records.

Type declaration

function(): void

Returns

void

Inherited from QueriableDataSource.selectAllLoadedRecords

selectRecordById

Interface Property

selectRecordById: (id: string, record?: FeatureDataRecord) => 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.

Type declaration

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

Parameters

Parameter	Type	Notes
`id`	string	The ID to be selected. The selection will be cleared if the ID is null.
`record`	FeatureDataRecord

Returns

void

selectRecordsByIds

Interface Property

selectRecordsByIds: (ids: string[], records?: FeatureDataRecord[]) => 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.

Type declaration

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

Parameters

Parameter	Type	Notes
`ids`	string[]	The IDs to be selected. The selection will be cleared if the IDs are null.
`records`	FeatureDataRecord[]

Returns

void

setCountStatus

optionalinheritedinherited

Interface Property

setCountStatus: (status: DataSourceStatus) => void

Update data source count status.

Type declaration

function(status: DataSourceStatus): void

Parameters

Parameter	Type
`status`	DataSourceStatus

Returns

void

Inherited from QueriableDataSource.setCountStatus

setDataSourceJson

inheritedinherited

Interface Property

setDataSourceJson: (dsJson: IMDataSourceJson) => void

Update data source JSON in data source instance

Type declaration

function(dsJson: IMDataSourceJson): void

Parameters

Parameter	Type
`dsJson`	IMDataSourceJson

Returns

void

Inherited from QueriableDataSource.setDataSourceJson

setListenSelection

inheritedinherited

Interface Property

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

Inherited from QueriableDataSource.setListenSelection

setRecords

inheritedinherited

Interface Property

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

Inherited from QueriableDataSource.setRecords

setSourceFeatures

Interface Property

setSourceFeatures: (features: Graphic | GraphicProperties[], others?: Omit<FeatureLayerProperties, "source" | "fields" | "objectIdField">) => Promise<void>

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.

Type declaration

function(features: Graphic | GraphicProperties[], others?: Omit<FeatureLayerProperties, "source" | "fields" | "objectIdField">): Promise<void>

Parameters

Parameter	Type
`features`	Graphic \| GraphicProperties[]
`others`	Omit<FeatureLayerProperties, "source" \| "fields" \| "objectIdField">

Returns

Promise<void>

setSourceRecords

Interface Property

setSourceRecords: (records: DataRecord[]) => void

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.

Type declaration

function(records: DataRecord[]): void

Parameters

Parameter	Type
`records`	DataRecord[]

Returns

void

setStatus

optionalinheritedinherited

Interface Property

setStatus: (status: DataSourceStatus) => void

Update data source status.

Type declaration

function(status: DataSourceStatus): void

Parameters

Parameter	Type
`status`	DataSourceStatus

Returns

void

Inherited from QueriableDataSource.setStatus

type

inheritedinherited

Interface Property

type: string

The type of the data source.

Inherited from QueriableDataSource.type

updateQueryParams

Interface Property

updateQueryParams: (query: ArcGISQueryParams, widgetId: string) => void

Update the data source query without executing the actual query.

Type declaration

function(query: ArcGISQueryParams, widgetId: string): void

Parameters

Parameter	Type
`query`	ArcGISQueryParams
`widgetId`	string

Returns

void

updateSelectionInfo

inheritedinherited

Interface Property

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 current 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

Inherited from QueriableDataSource.updateSelectionInfo

url

optional

Interface Property

url: string

The data source URL