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

BarChart (Next)

Grouped vertical bar chart for categorical metrics or barSeries payloads. Layout supplies legend keys and axis options. The channel carries categories + series or barSeries under shape: "value".

Summary

Value
Layout idBarChart
Widget configbarChartItem
Primary channel shapevalue (categories + series, or barSeries)

Migration status

migrated, full layout + dataservice reference: tools/arbex/reference/next/BarChart.json. See Dataservice migration status.

Layout

FieldDescription
channelsChannel id(s), typically one primary channel
barChartItem.legend[]{ key, label, color }, keys must match series[].key in payload
barChartItem.yAxismin, max, autoMin, autoMax, clamp, integerTicks, tickAmount
chartHeight, truncateXAxisLabelsOptional presentation

Schema: #/$defs/BarChartItemSchema in heat-layout-schema.json.

Data contract

ShapePayload
valuedata.value.categories + data.value.series[] with key, name, values[]
value (alt)data.value.barSeries[] with { name, data: [{ x, y, ... }] }

Registry also lists series and ranges for timeseries bar modes.

Example

See reference JSON (Storybook NearVsFarHitQuality pattern) and Arbex RAG tools/arbex/rag/reference/components/BarChart.md.

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