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
PropertyTypeNotes
() => 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.

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

The data source which this data source derives from.

buildRecord
inherited
(dataany) => DataRecord

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

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

() => 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

(dataSourceIdstring) => 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).

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.

() => DataSource[]

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

() => DataSource[]

Return the derived data views and local data sources.

() => DataRecord[]

Get records of all the loaded pages.

() => number

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

(jimuChildIdstring) => DataSource

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

() => DataSource[]

Return child data sources of a parent data source.

Get the user config query parameters.

Return data source count status.

() => string

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

(options?GetCurrentQueryParamsOptions) => QueryParams

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

() => IMDataSourceJson

The data source JSON object in app config.

() => IMDataViewJson

Return the config of the current data source.

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.

() => boolean

Return whether listen selection.

(localIdstring) => DataSource

Get local data source by local ID.

() => DataSource[]

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

() => number

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

(pageSizenumber, pagenumber) => number[]

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

(queryQueryParams, 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
(indexnumber) => DataRecord

Get record by index

getRecordById
inherited
(idstring) => DataRecord

Get record by ID

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

(pagenumber, pageSizenumber) => 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.

(pagenumber, pageSizenumber) => 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.

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

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

Return the root data source.

(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

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.

() => string[]

Get selected record IDs

() => number[]

Get selected record indexes

() => DataRecord[]

Get selected records

() => DataRecord[]

Return the source records

() => 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

Return data source status.

getVersion
inherited
() => number

Return data source version.

id
inherited
string

The data source ID.

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.

boolean

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

(queryQueryParams, 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 .

(idstring, refresh?boolean) => Promise<DataRecord>

Load record by ID, do not consider other queries.

(queryQueryParams, options?QueryOptions) => Promise<number>

Load the records count.

localId
inherited
string

The local ID of the data source.

(queriesQueryParams[]) => 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.

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

(queryQueryParams, 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 .

(queryQueryParams, 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.

(idstring, fields?string[]) => Promise<DataRecord>

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

(queryQueryParams, options?QueryOptions) => Promise<QueryResult>

Query count

(queryQueryParams, 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 .

(idstring, 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.

(idsstring[], 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.

(statusDataSourceStatus) => void

Update data source count status.

(dsJsonIMDataSourceJson) => void

Update data source JSON in data source instance

(listenboolean) => 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
(recordsDataRecord[]) => void

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

(recordsDataRecord[]) => 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
(statusDataSourceStatus) => void

Update data source status.

type
inherited
string

The type of the data source.

(queryQueryParams, widgetIdstring) => void

Update the data source query without executing the actual query.

(optionsSelectOptions, triggerDataSourceDataSource, 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).

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

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

belongToDataSource

optionalinherited
Interface Property
belongToDataSource: DataSource

The data source which this data source derives from.

buildRecord

inherited
Interface Property
buildRecord: (dataany) => DataRecord

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

Type declaration
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

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

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

count

optionalinherited
Interface Property
count: number

The total records count depends on the current query

Inherited from DataSource.count

createDataSourceById

optionalinherited
Interface Property
createDataSourceById: (dataSourceIdstring) => 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(dataSourceIdstring): Promise<DataSource>
    Parameters
    ParameterType
    dataSourceId
    string
    Returns 
    Promise<DataSource>

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.

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

getAllDerivedDataSources

inherited
Interface Property
getAllDerivedDataSources: () => DataSource[]

Return the derived data views and local data sources.

Type declaration

getAllLoadedRecords

Interface Property
getAllLoadedRecords: () => DataRecord[]

Get records of all the loaded pages.

Type declaration

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: (jimuChildIdstring) => DataSource

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

Type declaration
    function(jimuChildIdstring): DataSource
    Parameters
    ParameterType
    jimuChildId
    string
    Returns 
    DataSource

getChildDataSources

optionalinherited
Interface Property
getChildDataSources: () => DataSource[]

Return child data sources of a parent data source.

Type declaration

getConfigQueryParams

Interface Property
getConfigQueryParams: () => QueryParams

Get the user config query parameters.

Type declaration

getCountStatus

inherited
Interface Property
getCountStatus: () => DataSourceStatus

Return data source count status.

Type declaration

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
    ParameterType
    options
    GetCurrentQueryParamsOptions
    Returns 
    QueryParams

getDataSourceJson

inherited
Interface Property
getDataSourceJson: () => IMDataSourceJson

The data source JSON object in app config.

Type declaration
    function(): IMDataSourceJson
    Returns 
    IMDataSourceJson

getDataViewConfig

inherited
Interface Property
getDataViewConfig: () => IMDataViewJson

Return the config of the current data source.

Type declaration
    function(): IMDataViewJson
    Returns 
    IMDataViewJson

getDataViews

Interface Property
getDataViews: () => QueriableDataSource[]

Override parent interface to get correct type.

Type declaration

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

getLocalDataSource

inherited
Interface Property
getLocalDataSource: (localIdstring) => DataSource

Get local data source by local ID.

Type declaration

getLocalDataSources

inherited
Interface Property
getLocalDataSources: () => DataSource[]

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

Type declaration

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: (pageSizenumber, pagenumber) => number[]

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

Type declaration
    function(pageSizenumber, pagenumber): number[]
    Parameters
    ParameterType
    pageSize
    number
    page
    number
    Returns 
    number[]

getRealQueryParams

Interface Property
getRealQueryParams: (queryQueryParams, 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

getRecord

inherited
Interface Property
getRecord: (indexnumber) => DataRecord

Get record by index

Type declaration
Inherited from DataSource.getRecord

getRecordById

inherited
Interface Property
getRecordById: (idstring) => DataRecord

Get record by ID

Type declaration

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

getRecordsByPage

Interface Property
getRecordsByPage: (pagenumber, pageSizenumber) => 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(pagenumber, pageSizenumber): DataRecord[]
    Parameters
    ParameterType
    page
    number
    pageSize
    number
    Returns 
    DataRecord[]

getRecordsByPageWithSelection

Interface Property
getRecordsByPageWithSelection: (pagenumber, pageSizenumber) => 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(pagenumber, pageSizenumber): DataRecord[]
    Parameters
    ParameterType
    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

getRemoteQueryParams

Interface Property
getRemoteQueryParams: () => QueryParams

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

Type declaration

getRootDataSource

inherited
Interface Property
getRootDataSource: () => DataSource

Return the root data source.

Type declaration

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
    ParameterType
    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
Inherited from DataSource.getSchema

getSelectedRecordIds

inherited
Interface Property
getSelectedRecordIds: () => string[]

Get selected record IDs

Type declaration
    function(): string[]
    Returns 
    string[]

getSelectedRecordIndexes

inherited
Interface Property
getSelectedRecordIndexes: () => number[]

Get selected record indexes

Type declaration
    function(): number[]
    Returns 
    number[]

getSelectedRecords

inherited
Interface Property
getSelectedRecords: () => DataRecord[]

Get selected records

Type declaration

getSourceRecords

inherited
Interface Property
getSourceRecords: () => DataRecord[]

Return the source records

Type declaration

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

getStatus

inherited
Interface Property
getStatus: () => DataSourceStatus

Return data source status.

Type declaration
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 .

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

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: (queryQueryParams, 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

loadById

Interface Property
loadById: (idstring, refresh?boolean) => Promise<DataRecord>

Load record by ID, do not consider other queries.

Type declaration
    function(idstring, refresh?boolean): Promise<DataRecord>
    Parameters
    ParameterType
    id
    string
    refresh
    boolean
    Returns 
    Promise<DataRecord>

loadCount

Interface Property
loadCount: (queryQueryParams, options?QueryOptions) => Promise<number>

Load the records count.

Type declaration

localId

optionalinherited
Interface Property
localId: string

The local ID of the data source.

Inherited from DataSource.localId

mergeQueryParams

Interface Property
mergeQueryParams: (queriesQueryParams[]) => QueryParams

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

Type declaration

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.

query

Interface Property
query: (queryQueryParams, 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

queryAll

Interface Property
queryAll: (queryQueryParams, 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

queryById

Interface Property
queryById: (idstring, fields?string[]) => Promise<DataRecord>

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

Type declaration
    function(idstring, fields?string[]): Promise<DataRecord>
    Parameters
    ParameterType
    id
    string
    fields
    string[]
    Returns 
    Promise<DataRecord>

queryCount

Interface Property
queryCount: (queryQueryParams, options?QueryOptions) => Promise<QueryResult>

Query count

Type declaration

queryIds

Interface Property
queryIds: (queryQueryParams, 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

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: (idstring, 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(idstring, record?DataRecord): void
    Parameters
    ParameterTypeNotes
    id
    string

    The ID to be selected. The selection will be cleared if the ID is null.

    record
    DataRecord
    Returns 
    void

selectRecordsByIds

inherited
Interface Property
selectRecordsByIds: (idsstring[], 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(idsstring[], records?DataRecord[]): void
    Parameters
    ParameterTypeNotes
    ids
    string[]

    The IDs to be selected. The selection will be cleared if the IDs are null.

    records
    DataRecord[]
    Returns 
    void

setCountStatus

optionalinherited
Interface Property
setCountStatus: (statusDataSourceStatus) => void

Update data source count status.

Type declaration

setDataSourceJson

inherited
Interface Property
setDataSourceJson: (dsJsonIMDataSourceJson) => void

Update data source JSON in data source instance

Type declaration
    function(dsJsonIMDataSourceJson): void
    Parameters
    ParameterType
    dsJson
    IMDataSourceJson
    Returns 
    void

setListenSelection

inherited
Interface Property
setListenSelection: (listenboolean) => 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(listenboolean): void
    Parameters
    ParameterType
    listen
    boolean
    Returns 
    void

setRecords

inherited
Interface Property
setRecords: (recordsDataRecord[]) => void

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

Type declaration
Inherited from DataSource.setRecords

setSourceRecords

inherited
Interface Property
setSourceRecords: (recordsDataRecord[]) => 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

setStatus

optionalinherited
Interface Property
setStatus: (statusDataSourceStatus) => void

Update data source status.

Type declaration
Inherited from DataSource.setStatus

type

inherited
Interface Property
type: string

The type of the data source.

Inherited from DataSource.type

updateQueryParams

Interface Property
updateQueryParams: (queryQueryParams, widgetIdstring) => void

Update the data source query without executing the actual query.

Type declaration
    function(queryQueryParams, widgetIdstring): void
    Parameters
    ParameterType
    query
    QueryParams
    widgetId
    string
    Returns 
    void

updateSelectionInfo

inherited
Interface Property
updateSelectionInfo: (optionsSelectOptions, triggerDataSourceDataSource, 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

url

optional
Interface Property
url: string

The data source URL

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.