IUseCADataversePlannerConfig
@spartanfx/react / codeapps / IUseCADataversePlannerConfig
Interface: IUseCADataversePlannerConfig
Configuration for useCADataversePlanner.
Extends
ICAPlannerBaseConfig<string>
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
autoRefresh? | boolean | Enable auto-refresh after mutations (default: true). | ICAPlannerBaseConfig.autoRefresh |
cacheDuration? | number | Cache TTL for read results in ms (default: 60_000). | ICAPlannerBaseConfig.cacheDuration |
choiceColumns? | string[] | SharePoint-only: column names backed by Choice / Lookup / Person columns. The Planner schema is consumer-driven (it doesn't know which columns are Choice columns), so declare them here to enable automatic expansion of string labels to the { "@odata.type", Value, Id } object the SharePoint connector requires on create/update. No default — when omitted, no resolution is performed. Ignored for services that don't expose getReferencedEntity (e.g. Dataverse). See: https://learn.microsoft.com/en-us/power-apps/developer/code-apps/how-to/sharepoint-operations | ICAPlannerBaseConfig.choiceColumns |
debounceMs? | number | Debounce delay for refetch on date-range change (default: 300 ms). | ICAPlannerBaseConfig.debounceMs |
debug? | boolean | Enable verbose console logging (default: false). | ICAPlannerBaseConfig.debug |
endDate? | Date | Initial end of the visible range. Default: Dec 31 of current year. | ICAPlannerBaseConfig.endDate |
idColumn | string | Logical name of the primary key column on the Dataverse table — usually <entity>id (e.g. cr1a3_taskid). Must match the schema's idField.fieldName value supplied to the Planner. | - |
odataFilter? | string | Additional OData $filter to combine with the date-range clause. | ICAPlannerBaseConfig.odataFilter |
onError? | (error) => void | Error callback. Called for every operational failure. | ICAPlannerBaseConfig.onError |
onNotify? | CANotifyFn | Notification callback. If omitted, hook errors surface via error state only. | ICAPlannerBaseConfig.onNotify |
retryPolicy? | ICARetryPolicy | Retry policy for transient failures. | ICAPlannerBaseConfig.retryPolicy |
rowLimit? | number | Maximum records per fetch (default: 5000). | ICAPlannerBaseConfig.rowLimit |
schema | IPlannerSchema | Schema mapping internal planner fields to data source columns. | ICAPlannerBaseConfig.schema |
searchText? | string | Optional search text for client-side filtering. | ICAPlannerBaseConfig.searchText |
service | ICATabularService<CAPlannerRecord, string> | Generated tabular service from pac code add-data-source. | ICAPlannerBaseConfig.service |
startDate? | Date | Initial start of the visible range. Default: Jan 1 of current year. | ICAPlannerBaseConfig.startDate |