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.

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

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.

Pass widgetId/localId if need to execute the query.

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.

Query scope defines which data is returned when the query is executed in addition to the query parameters.

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

Pass widgetId/localId if need to execute the query.

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.

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

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.

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

Will call the function when the data source schema changes.

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

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.

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