ChartHeatmap

Data Display
stable

Rectangular heatmap chart. Renders a grid of SVG <rect> cells coloured by value via CSS color-mix interpolation. Common uses: GitHub activity grids, correlation matrices, weekday × hour patterns.

Structure

Anatomy

Visual breakdown of the component's internal structure with BEM class call-outs.

Anatomy of OrigamChartHeatmapSchematic of the ChartHeatmap component with 6 numbered internal parts. __header (title + subtitle) Mon Tue 9h 12h 0 50 1 2 3 4 5 6 ② cell fill = CSS color-mix(in srgb, colorRange[1] N%, colorRange[0]) — ⑤ gradient legend
Anatomy of <origam-chart-heatmap> — 6 internal parts. Cell colour interpolated via CSS color-mix(in srgb, …).
1.origam-chart-heatmap
Root element. CSS grid with areas: header / body. role="figure" + aria-label from title.
2.origam-chart__heatmap-cell
SVG for each data cell. Fill is CSS color-mix interpolated between colorRange endpoints. tabindex="0" + role="button".
3.origam-chart__heatmap-axis-label--y
Y-axis row labels (left side). Hidden when showAxis=false.
4.origam-chart__heatmap-axis-label--x
X-axis column labels (bottom). Hidden when showAxis=false.
5.origam-chart__heatmap-gradient-legend
Inline SVG gradient bar with min/max value labels. Visible when showGradientLegend=true and legendPosition is top or bottom.
6.origam-chart-heatmap__header
Title and subtitle block. Rendered only when title or subtitle is provided.

API

Props

All props accepted by this component, with their type, default value and description.

xCategories
Array<string>
[]
Explicit X-axis category ordering. When omitted, unique x values are sorted alphabetically/numerically.
yCategories
Array<string>
[]
Explicit Y-axis category ordering. When omitted, unique y values are sorted alphabetically/numerically.
colorRange
[TIntent | string, TIntent | string]
['info', 'danger']
Two-stop colour range. First entry = min value colour; second = max value colour. Accepts intent tokens or raw CSS strings.
cellGap
number
2
Gap between cells in SVG user units.
showLabel
boolean
true
Renders the numeric value centred inside each cell when the cell is large enough.
showAxis
boolean
true
Renders X and Y axis category labels along the grid edges.
showGradientLegend
boolean
true
Renders a gradient colour bar with min/max labels inline in the SVG.
legendPosition
TChartLegendPosition
'bottom'
Anchor of the gradient legend: 'top' | 'bottom' | 'left' | 'right'.
xAxisFormat
(value: string | number) => string
X-axis column label formatter.
yAxisFormat
(value: number) => string
Row label and gradient legend min/max formatter.
series
required
Array<IChartSeries>
—
Data series — only series[0] is consumed. Each datum must supply x, y and value.
categories
Array<string>
title
string
Optional title rendered above the plotting area.
subtitle
string
Optional subtitle rendered below the title.
showLegend
boolean
true
Controls the ChartLegend visibility.
showTooltip
boolean
true
Shows a tooltip on hover/focus with x, y and formatted value.
animated
boolean
true
Fades cells in on first paint. Respects prefers-reduced-motion.
animationDuration
number
600
Entry animation duration in ms.
colorScheme
Array<TIntent | string>
aspectRatio
string
CSS aspect-ratio shortcut. When set, overrides height.
id
string
class
string | Array<string> | object
style
string | Array<string> | object | StyleValue
height
number | string
400
Component height. Accepts a CSS length or a number (converted to px).
maxHeight
number | string
maxWidth
number | string
minHeight
number | string
minWidth
number | string
width
number | string
margin
boolean | number | string
marginTop
boolean | number | string
marginLeft
boolean | number | string
marginBottom
boolean | number | string
marginRight
boolean | number | string
marginBlock
boolean | number | string
marginInline
boolean | number | string
marginInlineStart
boolean | number | string
marginInlineEnd
boolean | number | string
marginBlockStart
boolean | number | string
marginBlockEnd
boolean | number | string
padding
boolean | number | string
paddingTop
boolean | number | string
paddingLeft
boolean | number | string
paddingBottom
boolean | number | string
paddingRight
boolean | number | string
paddingBlock
boolean | number | string
paddingInline
boolean | number | string
paddingInlineStart
boolean | number | string
paddingInlineEnd
boolean | number | string
paddingBlockStart
boolean | number | string
paddingBlockEnd
boolean | number | string
rounded
boolean | number | string | TRounded | null | undefined
roundedTopRight
boolean | number | string
roundedTopLeft
boolean | number | string
roundedBottomLeft
boolean | number | string
roundedBottomRight
boolean | number | string
roundedStartStart
boolean | number | string
roundedStartEnd
boolean | number | string
roundedEndStart
boolean | number | string
roundedEndEnd
boolean | number | string
elevation
TElevation
bgColor
Background colour applied to the chart root.
fontSize
TFontSize
fontWeight
TFontWeight

API

Slots

Content slots exposed by this component.

#tooltip
Replaces the default tooltip body for a hovered cell.
#title
Replaces the default title/subtitle block.
#empty
Shown when series is empty or has no renderable data.

API

Emits

Events emitted by this component.

@point-click
IChartPoint, MouseEvent | KeyboardEvent
Fired when the user clicks or keyboard-activates a cell.
@legend-click
IChartSeries, number
Fired when the user clicks a legend entry.
@series-toggle
IChartSeries, boolean
Fired after a legend click with the intended next visibility value.

Customisation

CSS variables

CSS custom properties exposed by this component. Override them to customise the component without losing theme compatibility.

Gap between header and body areas.
Internal padding of the chart root.
Background colour of the chart root.
Entry animation duration. Driven by animationDuration prop.
Stroke colour of cell rects (creates visible gap between cells).
Stroke width of cell rects.
Font size of cell value labels.
Fill colour of cell value labels.
Font size of axis labels.
Font size of the chart title.

Inclusion

Accessibility

ARIA roles, keyboard navigation and focus management. Sourced from the real component template.

ARIA roles

figure
img
button

Keyboard interactions

Keyboard interactions
KeyAction
TabMoves focus through each cell (tabindex="0").
Enter / SpaceActivates the focused cell, firing the point-click emit.

Notes

  • Root has role="figure" with aria-label from the title prop (falls back to "heatmap chart").
  • The SVG carries role="img" with a <title> and <desc> listing column and row counts.
  • Each cell has aria-label in the format "xCat × yCat: value" for screen reader announcement.
  • Entry animations are disabled via @media (prefers-reduced-motion: reduce).

Interactive

Playground

Edit props live and see the component update in real time. The generated code snippet updates as you change values.

Rendering the live preview…

Usage

Examples

Ready-to-paste code snippets for your templates.

Basic heatmap

vue

Custom colour range

vue

No cell labels

vue

Ecosystem

Family

Components from the same folder that share conventions and often compose together.