IUseCADataverseDataTableConfig
@spartanfx/react / codeapps / IUseCADataverseDataTableConfig
Interface: IUseCADataverseDataTableConfig<TRecord>
Configuration for useCADataverseDataTable.
Extends
ICADataTableBaseConfig<TRecord,string>
Type Parameters
TRecord
TRecord
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
appearance? | AppearanceMode | Appearance mode for theming. | ICADataTableBaseConfig.appearance |
autoRefresh? | boolean | Enable auto-refresh after mutations (default: true). | ICADataTableBaseConfig.autoRefresh |
cacheDuration? | number | Cache TTL for read results in ms (default: 60_000). | ICADataTableBaseConfig.cacheDuration |
columns? | ( | IColumn | IDataTableColumn<TRecord>)[] | Columns to display. May mix simplified IDataTableColumn and Fluent IColumn. | ICADataTableBaseConfig.columns |
debug? | boolean | Enable verbose console logging (default: false). | ICADataTableBaseConfig.debug |
fieldInfo? | IDataTableFieldType[] | Optional field metadata for renderers and tooltips. CodeApps services do not expose schema at runtime — supply this when you need rich column rendering (User, Lookup, Choice, DateTime, ...). | ICADataTableBaseConfig.fieldInfo |
filterDiscoveryLimit? | number | Sample size for the default filter-options discovery (default: 1000). Only used when onGetFilterOptions is not provided. | ICADataTableBaseConfig.filterDiscoveryLimit |
filterOptionsCacheTTL? | number | Cache TTL for filter-options results in ms (default: 5 minutes). Filter values are far less volatile than table data. | ICADataTableBaseConfig.filterOptionsCacheTTL |
groupByLevel1? | string | Field name for level-1 grouping. | ICADataTableBaseConfig.groupByLevel1 |
groupByLevel2? | string | Field name for level-2 grouping. | ICADataTableBaseConfig.groupByLevel2 |
groupByLevel3? | string | Field name for level-3 grouping. | ICADataTableBaseConfig.groupByLevel3 |
groupsDefaultCollapsed? | boolean | Whether groups start collapsed. | ICADataTableBaseConfig.groupsDefaultCollapsed |
inPlaceFilterItems? | (item) => boolean | Client-side post-filter. Applied after server-side filtering, useful for computed predicates the connector can't express. | ICADataTableBaseConfig.inPlaceFilterItems |
inPlaceSearchText? | string | Default search text. Triggers a filter that matches any of searchFields against the value via contains(). | ICADataTableBaseConfig.inPlaceSearchText |
odataFilter? | string | OData $filter expression applied to every read. Always AND-combined with column filters and search text. | ICADataTableBaseConfig.odataFilter |
onError? | (error) => void | Error callback. Called for every operational failure. | ICADataTableBaseConfig.onError |
onGetFilterOptions? | (fieldName, currentFilters) => Promise<IFilterCriteria[]> | Override the filter-options discovery. Default implementation queries the data source for distinct values from a top-N sample, which is inexact for large tables — supply a custom implementation for accurate results. | ICADataTableBaseConfig.onGetFilterOptions |
onNotify? | CANotifyFn | Notification callback. If omitted, hook errors surface via error state only. | ICADataTableBaseConfig.onNotify |
retryPolicy? | ICARetryPolicy | Retry policy for transient failures. | ICADataTableBaseConfig.retryPolicy |
rowLimit? | number | Page size (default: 100). | ICADataTableBaseConfig.rowLimit |
searchFields? | string[] | Columns to search across when onSearch is invoked. Required when search is enabled — OData has no built-in cross-column search. | ICADataTableBaseConfig.searchFields |
service | ICATabularService<TRecord & CADataTableRecord, string> | Generated tabular service from pac code add-data-source. | ICADataTableBaseConfig.service |
translate? | (text) => string | Translation function (rendered through component). | ICADataTableBaseConfig.translate |
translatedFields? | string[] | Fields whose filter values should be translated for display. | ICADataTableBaseConfig.translatedFields |