QueriableDataSource

Interface

QueriableDataSource extends DataSource and add query capability. A queriable data source must have an URL to execute the query.

The current default query implementation supports pagination. It allows mulitple widgets to apply queries on the same data source, all of which are merged by using the AND logic operator.

When execute a query, in addition to the passed in query parameters, all configured queries and all other widgets applied queries are merged by using the AND logic operator.

When a query is executed against a data view, the query from its main data source is used as well.

Inheritance: QueriableDataSourceDataSource

Subclasses: ArcGISQueriableDataSource

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.
`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 ( `dataSource.isDataSourceSet` is true).
`belongToDataSource` inherited	`DataSource`	The data source which this data source derives from.
`buildRecord` inherited	`(data: any) => DataRecord`	Builds a data record only -- does not add the record into data source.
`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 ( `dataSource.isDataSourceSet` is true).
`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 ( `dataSource.isDataSourceSet` is true).
`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` inherited	`() => Promise<IMDataSourceSchema>`	Fetch the data schema from an actual data source. If it's a statistic data source, the schema will not be fetched.
`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`	`() => DataRecord[]`	Get records of all the loaded pages.
`getAutoRefreshInterval`	`() => number`	If the return value > 0, auto refresh is enabled.
`getChildDataSource` inherited	`(jimuChildId: string) => DataSource`	Get child data source by `jimuChildId` . You can get `jimuChildId` by `getJimuChildId()` .
`getChildDataSources` inherited	`() => DataSource[]`	Return child data sources of a parent data source.
`getConfigQueryParams`	`() => QueryParams`	Get the user config query parameters.
`getCountStatus` inherited	`() => DataSourceStatus`	Return data source count status.
`getCurrentQueryId`	`() => string`	Get the current loaded record id, which is used in `loadById` method.
`getCurrentQueryParams`	`(options?: GetCurrentQueryParamsOptions) => QueryParams`	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`	`() => QueriableDataSource[]`	Override parent interface to get correct type.
`getIdField` inherited	`() => 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`	`() => number`	Null means there is no record count limit, and will return all records from the service.
`getRealQueryPages`	`(pageSize: number, page: number) => number[]`	Get real query page depends on the widget's request page.
`getRealQueryParams`	`(query: QueryParams, flag: "query" \| "load", options?: QueryOptions) => QueryParams`	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`	`() => 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`	`(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`	`(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`	`() => QueryParams`	Get the query parameters configured in remote (not in exb).
`getRootDataSource` inherited	`() => DataSource`	Return the root data source.
`getRuntimeQueryParams`	`(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
`getSourceRecords` inherited	`() => 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	`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` 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`	`boolean`	Whether the data source is case-sensitive when doing query by SQL clauses.
`load`	`(query: QueryParams, 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 returnd by `getRealQueryParams` .
`loadById`	`(id: string, refresh?: boolean) => Promise<DataRecord>`	Load record by ID, do not consider other queries.
`loadCount`	`(query: QueryParams, options?: QueryOptions) => Promise<number>`	Load the records count.
`localId` inherited	`string`	The local ID of the data source.
`mergeQueryParams`	`(queries: QueryParams[]) => QueryParams`	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`	The parent data source of this data source, mull means it's a root data source.
`query`	`(query: QueryParams, options?: QueryOptions) => Promise<QueryResult>`	Execute query against the service only, do NOT update the internal data records. The actural query parameters are generated by `getRealQueryParams` .
`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.
`queryById`	`(id: string, fields?: string[]) => Promise<DataRecord>`	Query record by ID. Will return all fields if not pass in the `fields` .
`queryCount`	`(query: QueryParams, options?: QueryOptions) => Promise<QueryResult>`	Query count
`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.
`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` .
`selectRecordById` inherited	`(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.
`selectRecordsByIds` inherited	`(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.
`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.
`setSourceRecords` inherited	`(records: DataRecord[]) => void`	When current data source is created from an array of records, will save it in `sourceRecords` . These two methods are used to update or get the source data.
`setStatus` inherited	`(status: DataSourceStatus) => void`	Update data source status.
`type` inherited	`string`	The type of the data source.
`updateQueryParams`	`(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 `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

inherited

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 DataSource.addSourceVersion

addVersion

optionalinherited

Interface Property

addVersion: () => void

Update data source version.

Type declaration

function(): void

Returns

void

Inherited from DataSource.addVersion

areChildDataSourcesCreated

optionalinherited

Interface Property

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

Inherited from DataSource.areChildDataSourcesCreated

belongToDataSource

optionalinherited

Interface Property

belongToDataSource: DataSource

The data source which this data source derives from.

Inherited from DataSource.belongToDataSource

buildRecord

inherited

Interface Property

buildRecord: (data: any) => DataRecord

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

Type declaration

function(data: any): DataRecord

Parameters

Parameter	Type
`data`	any

Returns

DataRecord

Inherited from DataSource.buildRecord

childDataSourcesReady

optionalinherited

Interface Property

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

Inherited from DataSource.childDataSourcesReady

clearRecords

optionalinherited

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 DataSource.clearRecords

clearSourceRecords

inherited

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 DataSource.clearSourceRecords

count

optionalinherited

Interface Property

count: number

The total records count depends on the current query

Inherited from DataSource.count

createDataSourceById

optionalinherited

Interface Property

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

Returns

Promise<DataSource>

Inherited from DataSource.createDataSourceById

dataSourceManager

inherited

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 DataSource.dataSourceManager

dataViewId

optionalinherited

Interface Property

dataViewId: string

The data view ID configured in JSON.

Inherited from DataSource.dataViewId

destroy

inherited

Interface Property

destroy: () => void

Destroy the data source.

Type declaration

function(): void

Returns

void

Inherited from DataSource.destroy

fetchSchema

inherited

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>

Inherited from DataSource.fetchSchema

getAllChildDataSources

optionalinherited

Interface Property

getAllChildDataSources: () => DataSource[]

Return all child data sources of a parent data source, includes the grandchildren

Type declaration

function(): DataSource[]

Returns

DataSource[]

Inherited from DataSource.getAllChildDataSources

getAllDerivedDataSources

inherited

Interface Property

getAllDerivedDataSources: () => DataSource[]

Return the derived data views and local data sources.

Type declaration

function(): DataSource[]

Returns

DataSource[]

Inherited from DataSource.getAllDerivedDataSources

getAllLoadedRecords

Interface Property

getAllLoadedRecords: () => DataRecord[]

Get records of all the loaded pages.

Type declaration

function(): DataRecord[]

Returns

DataRecord[]

getAutoRefreshInterval

Interface Property

getAutoRefreshInterval: () => number

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

Type declaration

function(): number

Returns

number

getChildDataSource

optionalinherited

Interface Property

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

Returns

DataSource

Inherited from DataSource.getChildDataSource

getChildDataSources

optionalinherited

Interface Property

getChildDataSources: () => DataSource[]

Return child data sources of a parent data source.

Type declaration

function(): DataSource[]

Returns

DataSource[]

Inherited from DataSource.getChildDataSources

getConfigQueryParams

Interface Property

getConfigQueryParams: () => QueryParams

Get the user config query parameters.

Type declaration

function(): QueryParams

Returns

QueryParams

getCountStatus

inherited

Interface Property

getCountStatus: () => DataSourceStatus

Return data source count status.

Type declaration

function(): DataSourceStatus

Returns

DataSourceStatus

Inherited from DataSource.getCountStatus

getCurrentQueryId

Interface Property

getCurrentQueryId: () => string

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

Type declaration

function(): string

Returns

string

getCurrentQueryParams

Interface Property

getCurrentQueryParams: (options?: GetCurrentQueryParamsOptions) => QueryParams

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

Type declaration

function(options?: GetCurrentQueryParamsOptions): QueryParams

Parameters

Parameter	Type
`options`	GetCurrentQueryParamsOptions

Returns

QueryParams

getDataSourceJson

inherited

Interface Property

getDataSourceJson: () => IMDataSourceJson

The data source JSON object in app config.

Type declaration

function(): IMDataSourceJson

Returns

IMDataSourceJson

Inherited from DataSource.getDataSourceJson

getDataViewConfig

inherited

Interface Property

getDataViewConfig: () => IMDataViewJson

Return the config of the current data source.

Type declaration

function(): IMDataViewJson

Returns

IMDataViewJson

Inherited from DataSource.getDataViewConfig

getDataViews

Interface Property

getDataViews: () => QueriableDataSource[]

Override parent interface to get correct type.

Type declaration

function(): QueriableDataSource[]

Returns

QueriableDataSource[]

getIdField

inherited

Interface Property

getIdField: () => string

Return the data source ID field.

Type declaration

function(): string

Returns

string

Inherited from DataSource.getIdField

getInfo

inherited

Interface Property

getInfo: () => IMDataSourceInfo

Return the data source info in redux store.

Type declaration

function(): IMDataSourceInfo

Returns

IMDataSourceInfo

Inherited from DataSource.getInfo

getLabel

inherited

Interface Property

getLabel: () => string

Return data source label.

Type declaration

function(): string

Returns

string

Inherited from DataSource.getLabel

getListenSelection

inherited

Interface Property

getListenSelection: () => boolean

Return whether listen selection.

Type declaration

function(): boolean

Returns

boolean

Inherited from DataSource.getListenSelection

getLocalDataSource

inherited

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 DataSource.getLocalDataSource

getLocalDataSources

inherited

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 DataSource.getLocalDataSources

getMaxRecordCount

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

getRealQueryPages

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

getRealQueryParams

Interface Property

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

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: QueryParams, flag: "query" | "load", options?: QueryOptions): QueryParams

Parameters

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

Returns

QueryParams

getRecord

inherited

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 DataSource.getRecord

getRecordById

inherited

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 DataSource.getRecordById

getRecords

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

getRecordsByPage

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

getRecordsByPageWithSelection

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

getRecordsWithSelection

inherited

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 DataSource.getRecordsWithSelection

getRemoteQueryParams

Interface Property

getRemoteQueryParams: () => QueryParams

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

Type declaration

function(): QueryParams

Returns

QueryParams

getRootDataSource

inherited

Interface Property

getRootDataSource: () => DataSource

Return the root data source.

Type declaration

function(): DataSource

Returns

DataSource

Inherited from DataSource.getRootDataSource

getRuntimeQueryParams

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

getSchema

inherited

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 DataSource.getSchema

getSelectedRecordIds

inherited

Interface Property

getSelectedRecordIds: () => string[]

Get selected record IDs

Type declaration

function(): string[]

Returns

string[]

Inherited from DataSource.getSelectedRecordIds

getSelectedRecordIndexes

inherited

Interface Property

getSelectedRecordIndexes: () => number[]

Get selected record indexes

Type declaration

function(): number[]

Returns

number[]

Inherited from DataSource.getSelectedRecordIndexes

getSelectedRecords

inherited

Interface Property

getSelectedRecords: () => DataRecord[]

Get selected records

Type declaration

function(): DataRecord[]

Returns

DataRecord[]

Inherited from DataSource.getSelectedRecords

getSourceRecords

inherited

Interface Property

getSourceRecords: () => DataRecord[]

Return the source records

Type declaration

function(): DataRecord[]

Returns

DataRecord[]

Inherited from DataSource.getSourceRecords

getSourceVersion

inherited

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 DataSource.getSourceVersion

getStatus

inherited

Interface Property

getStatus: () => DataSourceStatus

Return data source status.

Type declaration

function(): DataSourceStatus

Returns

DataSourceStatus

Inherited from DataSource.getStatus

getVersion

inherited

Interface Property

getVersion: () => number

Return data source version.

Type declaration

function(): number

Returns

number

Inherited from DataSource.getVersion

id

inherited

Interface Property

id: string

The data source ID.

Inherited from DataSource.id

isDataSourceSet

inherited

Interface Property

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 .

Inherited from DataSource.isDataSourceSet

isDataView

inherited

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 DataSource.isDataView

isInAppConfig

inherited

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 DataSource.isInAppConfig

isLocal

inherited

Interface Property

isLocal: boolean

True means the data source is a local data source.

Inherited from DataSource.isLocal

isSqlCaseSensitive

Interface Property

isSqlCaseSensitive: boolean

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

load

Interface Property

load: (query: QueryParams, 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 returnd 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: QueryParams, options?: QueryOptions): Promise<DataRecord[]>

Parameters

Parameter	Type
`query`	QueryParams
`options`	QueryOptions

Returns

Promise<DataRecord[]>

loadById

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>

loadCount

Interface Property

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

Load the records count.

Type declaration

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

Parameters

Parameter	Type
`query`	QueryParams
`options`	QueryOptions

Returns

Promise<number>

localId

optionalinherited

Interface Property

localId: string

The local ID of the data source.

Inherited from DataSource.localId

mergeQueryParams

Interface Property

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

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

Type declaration

function(queries: QueryParams[]): QueryParams

Parameters

Parameter	Type
`queries`	QueryParams[]

Returns

QueryParams

order

optionalinherited

Interface Property

order: number

Order in the parent data source.

Inherited from DataSource.order

parentDataSource

inherited

Interface Property

parentDataSource: DataSource

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

Inherited from DataSource.parentDataSource

query

Interface Property

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

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

To query count, please use queryCount .

Type declaration

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

Parameters

Parameter	Type
`query`	QueryParams
`options`	QueryOptions

Returns

Promise<QueryResult>

queryAll

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>

queryById

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>

queryCount

Interface Property

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

Query count

Type declaration

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

Parameters

Parameter	Type
`query`	QueryParams
`options`	QueryOptions

Returns

Promise<QueryResult>

queryIds

Interface Property

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

inherited

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 DataSource.ready

selectRecordById

inherited

Interface Property

selectRecordById: (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.

Type declaration

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

Parameters

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

Returns

void

Inherited from DataSource.selectRecordById

selectRecordsByIds

inherited

Interface Property

selectRecordsByIds: (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.

Type declaration

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

Parameters

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

Returns

void

Inherited from DataSource.selectRecordsByIds

setCountStatus

optionalinherited

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 DataSource.setCountStatus

setDataSourceJson

inherited

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 DataSource.setDataSourceJson

setListenSelection

inherited

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 DataSource.setListenSelection

setRecords

inherited

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 DataSource.setRecords

setSourceRecords

inherited

Interface Property

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

When current data source is created from an array of records, will save it in sourceRecords . These two methods are used to update or get the source data.

Type declaration

function(records: DataRecord[]): void

Parameters

Parameter	Type
`records`	DataRecord[]

Returns

void

Inherited from DataSource.setSourceRecords

setStatus

optionalinherited

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 DataSource.setStatus

type

inherited

Interface Property

type: string

The type of the data source.

Inherited from DataSource.type

updateQueryParams

Interface Property

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

Returns

void

updateSelectionInfo

inherited

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 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
`triggerDataSource`	DataSource
`forceCheck`	boolean

Returns

void

Inherited from DataSource.updateSelectionInfo

url

optional

Interface Property

url: string

The data source URL