ICADataTableBaseConfig
@spartanfx/react / codeapps / ICADataTableBaseConfig
Interface: ICADataTableBaseConfig<TRecord, TId>
Base config shared by CodeApps DataTable adapters.
Extends
Extended by
Type Parameters
TRecord
TRecord
TId
TId extends string | number = string
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
appearance? | AppearanceMode | Appearance mode for theming. | - |
autoRefresh? | boolean | Enable auto-refresh after mutations (default: true). | ICAAdapterBaseConfig.autoRefresh |
cacheDuration? | number | Cache TTL for read results in ms (default: 60_000). | ICAAdapterBaseConfig.cacheDuration |
columns? | ( | IColumn | IDataTableColumn<TRecord>)[] | Columns to display. May mix simplified IDataTableColumn and Fluent IColumn. | - |
debug? | boolean | Enable verbose console logging (default: false). | ICAAdapterBaseConfig.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, ...). | - |
filterDiscoveryLimit? | number | Sample size for the default filter-options discovery (default: 1000). Only used when onGetFilterOptions is not provided. | - |
filterOptionsCacheTTL? | number | Cache TTL for filter-options results in ms (default: 5 minutes). Filter values are far less volatile than table data. | - |
groupByLevel1? | string | Field name for level-1 grouping. | - |
groupByLevel2? | string | Field name for level-2 grouping. | - |
groupByLevel3? | string | Field name for level-3 grouping. | - |
groupsDefaultCollapsed? | boolean | Whether groups start collapsed. | - |
inPlaceFilterItems? | (item) => boolean | Client-side post-filter. Applied after server-side filtering, useful for computed predicates the connector can't express. | - |
inPlaceSearchText? | string | Default search text. Triggers a filter that matches any of searchFields against the value via contains(). | - |
odataFilter? | string | OData $filter expression applied to every read. Always AND-combined with column filters and search text. | - |
onError? | (error) => void | Error callback. Called for every operational failure. | ICAAdapterBaseConfig.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. | - |
onNotify? | CANotifyFn | Notification callback. If omitted, hook errors surface via error state only. | ICAAdapterBaseConfig.onNotify |
retryPolicy? | ICARetryPolicy | Retry policy for transient failures. | ICAAdapterBaseConfig.retryPolicy |
rowLimit? | number | Page size (default: 100). | - |
searchFields? | string[] | Columns to search across when onSearch is invoked. Required when search is enabled — OData has no built-in cross-column search. | - |
service | ICATabularService<TRecord & CADataTableRecord, TId> | Generated tabular service from pac code add-data-source. | - |
translate? | (text) => string | Translation function (rendered through component). | - |
translatedFields? | string[] | Fields whose filter values should be translated for display. | - |