UseTimeSeriesStoreWorkerOptions
Defined in: hooks/useTimeSeriesStoreWorker.ts:21
Type Parameters
Section titled “Type Parameters”T extends TimePoint
Properties
Section titled “Properties”clientRef?
Section titled “clientRef?”
optionalclientRef:MutableRefObject<ChartDataWorkerClient|null>
Defined in: hooks/useTimeSeriesStoreWorker.ts:37
Optional ref to receive the worker client instance (for debug queries etc.).
coldRefreshEveryN?
Section titled “coldRefreshEveryN?”
optionalcoldRefreshEveryN:number
Defined in: hooks/useTimeSeriesStoreWorker.ts:33
Run cold (full downsampled) refresh every Nth tick (default: 20).
drainInterval?
Section titled “drainInterval?”
optionaldrainInterval:number
Defined in: hooks/useTimeSeriesStoreWorker.ts:29
Polling interval in ms for draining the IngestBuffer (default: 250).
enabled?
Section titled “enabled?”
optionalenabled:boolean
Defined in: hooks/useTimeSeriesStoreWorker.ts:39
Set to false to disable the Worker (no Worker is spawned). Default: true.
hotRowBudget?
Section titled “hotRowBudget?”
optionalhotRowBudget:number
Defined in: hooks/useTimeSeriesStoreWorker.ts:35
Trigger cold refresh when hot buffer exceeds this many rows (default: 500).
ingestBufferRef
Section titled “ingestBufferRef”ingestBufferRef:
RefObject<IngestBuffer<T>>
Defined in: hooks/useTimeSeriesStoreWorker.ts:23
maxPoints?
Section titled “maxPoints?”
optionalmaxPoints:number
Defined in: hooks/useTimeSeriesStoreWorker.ts:27
Maximum number of points to display (default: DISPLAY_MAX_POINTS).
schema
Section titled “schema”schema:
TableSchema<T>
Defined in: hooks/useTimeSeriesStoreWorker.ts:22
tickInterval?
Section titled “tickInterval?”
optionaltickInterval:number
Defined in: hooks/useTimeSeriesStoreWorker.ts:31
Worker tick interval in ms (default: 250).
timeRange?
Section titled “timeRange?”
optionaltimeRange:TimeRange
Defined in: hooks/useTimeSeriesStoreWorker.ts:25
Show only last N seconds of data, or null for all history.