DataSourceComponentProps

If one of your children component's render depends on data source, please use this render function. Otherwise, even if the data record in the data source is changed, your children will not be re-rendered unless you connect the data source info in the children owner component to re-render the owner component.

See here for the difference between parent and owner context: https://gist.github.com/jimfb/0eb6e61f300a8c1b2ce7.

If the creation of the data source fails, this string will be shown.

Increment forceRefreshVersion to force data source to load even if the query parameter does not change. Please note, all widgets using the data source will refresh, too.

Will call the function when all the child data sources are created. Please note the function is valid only when the current data source is data source set.

Type declaration

function(ds: DataSource): void

Parameters

Parameter	Type
ds	DataSource

Returns 

void

Will call the function when fail to create the data source.

Type declaration

function(err: any): void

Parameters

Parameter	Type
err	any

Returns 

void

Will call the function when the data source is created. Please note that some child data sources may not have been created by the time the current data source is created.

Type declaration

function(ds: DataSource): void

Parameters

Parameter	Type
ds	DataSource

Returns 

void

Will call the function when the data source info changes and on the component is mounted.

Type declaration

function(info: IMDataSourceInfo, preInfo?: IMDataSourceInfo): void

Parameters

Parameter	Type
info	IMDataSourceInfo
preInfo	IMDataSourceInfo

Returns 

void

Will call the function when the data source schema changes.

Type declaration

function(schema: IMDataSourceSchema, prevSchema?: IMDataSourceSchema): void

Parameters

Parameter	Type
schema	IMDataSourceSchema
prevSchema	IMDataSourceSchema

Returns 

void

Will call the function when the data source status changes and on the component is mounted.

Type declaration

function(status: DataSourceStatus, preStatus?: DataSourceStatus): void

Parameters

Parameter	Type
status	DataSourceStatus
preStatus	DataSourceStatus

Returns 

void

Widgets may not pass in query props to load records into data source instance. In this case, widgets still need to listen to data source changes to refresh themselves. This callback is triggered whenever the data source properties such as filters or gdbVersion change, and on the component is mounted. For example, adding a filter to data source will trigger the callback and selecting a record won't.

Please note this callback will be valid only when the query prop is not used.

Type declaration

function(queryRequiredInfo: QueryRequiredInfo, preQueryRequiredInfo?: QueryRequiredInfo): void

Parameters

Parameter	Type
queryRequiredInfo	QueryRequiredInfo
preQueryRequiredInfo	QueryRequiredInfo

Returns 

void

Will call the function when the selected records change and on the component is mounted.

The selection is shared between the main data source, data view, and local data source and local data view. So this callback will be invoked when selection is make on any of them.

Note that the local data source or local data view does not listen to the selection by default, you need to call setListenSelection(true)to enable it when you need to.

Type declaration

function(selection: ImmutableArray<string>, preSelection?: ImmutableArray<string>): void

Parameters

Parameter	Type
selection	ImmutableArray<string>
preSelection	ImmutableArray<string>

Returns 

void

Query parameters of queriable data source. The component does not execute a query without query property. To execute a query without adding new filter, please use an empty object: {}.

Whether to load all the records page by page or not. Loading all records may take a long time and may cause performance issues. We recommend using the queryAllProgress and the queryAllSignal to show the progress and cancel the query if necessary.

Only valid when queryAll is true. The function is called when the query is in progress.

Only valid when queryAll is true. The signal object is used to communicate with the query requests. See https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal for more information.

Whether load record count when loading data records or not.

Data source used by widget. Either useDataSource or dataSource is required.

• If the used data source is configured in settings and is saved in widget json, please use useDataSource .
• If the used data source is added in runtime and is not saved in widget json, please use dataSource .
• If pass in both useDataSource and dataSource , will use dataSource .

Pass widgetId/localId if need to execute the query.

For main data source or data view, please use widgetId. For local data source, please use localId. The recommended localId is: widgetId + ??? .