Skip to Content
This documentation is provided with the HEAT environment and describes this HEAT instance.

TimelineChart (Next)

⚠️

Partial migration. TimelineChart consumes $heat-dataservice channels but embeds v1-style per-series config in timelineItems[]. Do not use for new Arbex layouts. Use ComposableChart instead.

Legacy Apex-based multi-series panel with radio-selectable lanes (area, scatter, range bar, vertical lines).

Summary

Value
Layout idTimelineChart
Widget configtimelineItems (array)
Channel shapesseries, events, ranges, timestamps
Migration targetComposableChart

Migration status

partial, reference includes _migrationNote: tools/arbex/reference/next/TimelineChart.json. See Dataservice migration status.

Layout

FieldDescription
channelsAll timelineItems[].channelId values
timelineItems[]Per-series type, color, unit, radioLabel, position, channelType, channelTypeInfo, playback flags, optional symbol
enablePlaybackControlsRow-level scrub
isSymbolToggleShow the symbol legend instead of the radio legend. Default false

Symbol legend

Set isSymbolToggle: true on the column to show the symbol legend. It renders as one row that wraps when it runs out of space. Scatter series come first, then the rest, each group in position order. Every series starts selected and can be toggled.

Each item’s icon follows its type unless symbol is set.

typeDefault icon
scatter1, scatter2, scatter3circle
rangeBarsquare
annotation, verticalLineline-vertical
arealine-horizontal

Valid symbol values are circle, square, horizontal-rectangle, vertical-rectangle, line-vertical and line-horizontal. statsDataset items are not shown in the legend.

Often dual-column with CognitiveLoad.

Realm selection

The panel dropdown lists the page realms and keeps a local selection. Set realmGroupId on the column to subscribe the chart to a realm group declared in configuration.realmGroups: the dropdown then lists that group’s realms, and choosing one updates every widget in the same group. Two TimelineCharts in one group compare the same realm; two groups compare different realms side by side. The column defaultRealm key is deprecated but still sets the starting realm when no group is used. See the Arbex layout reference for the group contract.

Data contract

ShapeUse
seriesArea/scatter series (timeMs, value)
eventsPoint events (timeMs, occurred)
rangesInterval bars
timestampsPlayback / annotation marks

Presentation (colors, radio groups) lives in layout, not only in channel metadata.

Example

Realistic timelineItems + mock timeline channels: TimelineChart.json. RAG: tools/arbex/rag/reference/components/TimelineChart.md.

Opens your browser's print dialog. Choose "Save as PDF" as the destination.