QueriableDataSource

Type declaration

function(): 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.

Returns 

void

Type declaration

function(): void

Update data source version.

Returns 

void

Type declaration

function(): 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).

Returns 

boolean

The data source which this data source derives from.

Type declaration

function(data: any): DataRecord

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

Parameters

Parameter	Type
data	any

Returns 

DataRecord

Type declaration

function(): 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).

Returns 

Promise<DataSource[]>

Type declaration

function(): 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.

Returns 

void

Type declaration

function(): void

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

Returns 

void

The total records count depends on the current query

Type declaration

function(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.

Parameters

Parameter	Type
dataSourceId	string

Returns 

Promise<DataSource>

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.

Type declaration

function(): void

Destroy the data source.

Returns 

void

Type declaration

function(): Promise<IMDataSourceSchema>

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

Returns 

Promise<IMDataSourceSchema>

Type declaration

function(): DataSource[]

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

Returns 

DataSource[]

Type declaration

function(): DataSource[]

Return the derived data views and local data sources.

Returns 

DataSource[]

Type declaration

function(): number

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

Returns 

number

Type declaration

function(jimuChildId: string): DataSource

Get child data source by jimuChildId . You can get jimuChildId by getJimuChildId() .

Parameters

Parameter	Type
jimuChildId	string

Returns 

DataSource

Type declaration

function(): DataSource[]

Return child data sources of a parent data source.

Returns 

DataSource[]

Type declaration

function(): QueryParams

Get the user config query parameters.

Returns 

QueryParams

Type declaration

function(): DataSourceStatus

Return data source count status.

Returns 

DataSourceStatus

Type declaration

function(): string

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

Returns 

string

Type declaration

function(options?: GetCurrentQueryParamsOptions): QueryParams

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

Parameters

Parameter	Type
options	GetCurrentQueryParamsOptions

Returns 

QueryParams

Type declaration

function(): IMDataSourceJson

The data source JSON object in app config.

Returns 

IMDataSourceJson

Type declaration

function(): IMDataViewJson

Return the config of the current data source.

Returns 

IMDataViewJson

Type declaration

function(): QueriableDataSource[]

Override parent interface to get correct type.

Returns 

QueriableDataSource[]

Type declaration

function(): string

Return the data source ID field.

Returns 

string

Type declaration

function(): IMDataSourceInfo

Return the data source info in redux store.

Returns 

IMDataSourceInfo

Type declaration

function(): string

Return data source label.

Returns 

string

Type declaration

function(): boolean

Return whether listen selection.

Returns 

boolean

Type declaration

function(localId: string): DataSource

Get local data source by local ID.

Parameters

Parameter	Type
localId	string

Returns 

DataSource

Type declaration

function(): DataSource[]

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

Returns 

DataSource[]

Type declaration

function(): number

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

Returns 

number

Type declaration

function(pageSize: number, page: number): number[]

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

Parameters

Parameter	Type
pageSize	number
page	number

Returns 

number[]

Type declaration

function(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.

Parameters

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

Returns 

QueryParams

Type declaration

function(index: number): DataRecord

Get record by index

Parameters

Parameter	Type
index	number

Returns 

DataRecord

Type declaration

function(id: string): DataRecord

Get record by ID

Parameters

Parameter	Type
id	string

Returns 

DataRecord

Type declaration

function(): DataRecord[]

Get records

Returns 

DataRecord[]

Type declaration

function(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.

Parameters

Parameter	Type
page	number
pageSize	number

Returns 

DataRecord[]

Type declaration

function(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.

Parameters

Parameter	Type
page	number
pageSize	number

Returns 

DataRecord[]

Type declaration

function(): 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.

Returns 

DataRecord[]

Type declaration

function(): QueryParams

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

Returns 

QueryParams

Type declaration

function(): DataSource

Return the root data source.

Returns 

DataSource

Type declaration

function(excludeWidgetId?: string): QueryParams

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

Parameters

Parameter	Type
excludeWidgetId	string

Returns 

QueryParams

Type declaration

function(): 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.

Returns 

IMDataSourceSchema

Type declaration

function(): string[]

Get selected record IDs

Returns 

string[]

Type declaration

function(): number[]

Get selected record indexes

Returns 

number[]

Type declaration

function(): DataRecord[]

Get selected records

Returns 

DataRecord[]

Type declaration

function(): DataRecord[]

Return the source records

Returns 

DataRecord[]

Type declaration

function(): number

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

Returns 

number

Type declaration

function(): DataSourceStatus

Return data source status.

Returns 

DataSourceStatus

Type declaration

function(): number

Return data source version.

Returns 

number

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.

Type declaration

function(): boolean

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

Returns 

boolean

True means the data source is a local data source.

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

Type declaration

function(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.

Parameters

Parameter	Type
query	QueryParams
options	QueryOptions

Returns 

Promise<DataRecord[]>

Type declaration

function(id: string, refresh?: boolean): Promise<DataRecord>

Load record by ID, do not consider other queries.

Parameters

Parameter	Type
id	string
refresh	boolean

Returns 

Promise<DataRecord>

Type declaration

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

Load the records count.

Parameters

Parameter	Type
query	QueryParams
options	QueryOptions

Returns 

Promise<number>

The local ID of the data source.

Type declaration

function(queries: QueryParams[]): QueryParams

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

Parameters

Parameter	Type
queries	QueryParams[]

Returns 

QueryParams

Order in the parent data source.

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

Type declaration

function(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 .

Parameters

Parameter	Type
query	QueryParams
options	QueryOptions

Returns 

Promise<QueryResult>

Type declaration

function(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.

Parameters

Parameter	Type
query	QueryParams
signal	AbortSignal
progressCallback	QueryProgressCallback
options	QueryOptions

Returns 

Promise<QueryResult>

Type declaration

function(id: string): Promise<DataRecord>

Query record by ID

Parameters

Parameter	Type
id	string

Returns 

Promise<DataRecord>

Type declaration

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

Query count

Parameters

Parameter	Type
query	QueryParams
options	QueryOptions

Returns 

Promise<QueryResult>

Type declaration

function(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.

Parameters

Parameter	Type
query	QueryParams
options	QueryOptions

Returns 

Promise<QueryResult>

Type declaration

function(): 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 .

Returns 

Promise<any>

Type declaration

function(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.

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

Type declaration

function(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.

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

Type declaration

function(status: DataSourceStatus): void

Update data source count status.

Parameters

Parameter	Type
status	DataSourceStatus

Returns 

void

Type declaration

function(dsJson: IMDataSourceJson): void

Update data source JSON in data source instance

Parameters

Parameter	Type
dsJson	IMDataSourceJson

Returns 

void

Type declaration

function(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.

Parameters

Parameter	Type
listen	boolean

Returns 

void

Type declaration

function(records: DataRecord[]): void

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

Parameters

Parameter	Type
records	DataRecord[]

Returns 

void

Type declaration

function(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.

Parameters

Parameter	Type
records	DataRecord[]

Returns 

void

Type declaration

function(status: DataSourceStatus): void

Update data source status.

Parameters

Parameter	Type
status	DataSourceStatus

Returns 

void

The type of the data source.

Type declaration

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

Update the data source query without executing the actual query.

Parameters

Parameter	Type
query	QueryParams
widgetId	string

Returns 

void

Type declaration

function(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.

Parameters

Parameter	Type
options	SelectOptions
triggerDataSource	DataSource
forceCheck	boolean

Returns 

void

The data source URL