How do I create a clustered heatmap chart in JavaScript?

Install with `npm install katucharts.js`, import the module with `import 'katucharts.js/bio';`, then call KatuCharts.chart(container, { chart: { type: 'clusteredheatmap' }, series: [...] }).

Why does my clustered heatmap chart render as a line chart?

The chart type was not registered. KatuCharts logs "KatuCharts: unknown series type " ", falling back to line" and draws a line chart rather than throwing. Import the module the type belongs to — for example `import 'katucharts.js/bio';` — before creating the chart.

Why do I get "Cannot read properties of null (reading 'appendChild')"?

The container element does not exist when the chart is created. Create the chart after the element is in the DOM: in React that means inside useEffect, not during render.

Why is the chart rendering with zero height?

The container has no height. A div with no content collapses to zero. Give it a height in CSS, or pass `chart: { height: 400 }` in the options.

Bioinformatics · katucharts.js/bio

Clustered Heatmap

type: 'clusteredheatmap'

Heatmap with hierarchical clustering dendrograms on rows and/or columns — common for gene-expression analysis.

Edit the JSON on the right and press Run (or ⌘/Ctrl + Enter) — data, titles, categories and colors all update live.

Live

Clustered Heatmap

Edit · JSON

{
  "chart": {
    "type": "clusteredheatmap"
  },
  "title": {
    "text": "Expression Matrix"
  },
  "series": [
    {
      "name": "Expression",
      "data": [
        {
          "x": 0,
          "y": 0,
          "value": 0
        },
        {
          "x": 1,
          "y": 0,
          "value": 3
        },
        {
          "x": 2,
          "y": 0,
          "value": 38
        },
        {
          "x": 3,
          "y": 0,
          "value": 55
        },
        {
          "x": 4,
          "y": 0,
          "value": 25
        },
        {
          "x": 5,
          "y": 0,
          "value": 4
        },
        {
          "x": 6,
          "y": 0,
          "value": 8
        },
        {
          "x": 7,
          "y": 0,
          "value": 61
        },
        {
          "x": 0,
          "y": 1,
          "value": 62
        },
        {
          "x": 1,
          "y": 1,
          "value": 50
        },
        {
          "x": 2,
          "y": 1,
          "value": 82
        },
        {
          "x": 3,
          "y": 1,
          "value": 95
        },
        {
          "x": 4,
          "y": 1,
          "value": 11
        },
        {
          "x": 5,
          "y": 1,
          "value": 80
        },
        {
          "x": 6,
          "y": 1,
          "value": 23
        },
        {
          "x": 7,
          "y": 1,
          "value": 18
        },
        {
          "x": 0,
          "y": 2,
          "value": 44
        },
        {
          "x": 1,
          "y": 2,
          "value": 18
        },
        {
          "x": 2,
          "y": 2,
          "value": 82
        },
        {
          "x": 3,
          "y": 2,
          "value": 54
        },
        {
          "x": 4,
          "y": 2,
          "value": 60
        },
        {
          "x": 5,
          "y": 2,
          "value": 80
        },
        {
          "x": 6,
          "y": 2,
          "value": 55
        },
        {
          "x": 7,
          "y": 2,
          "value": 40
        },
        {
          "x": 0,
          "y": 3,
          "value": 46
        },
        {
          "x": 1,
          "y": 3,
          "value": 12
        },
        {
          "x": 2,
          "y": 3,
          "value": 12
        },
        {
          "x": 3,
          "y": 3,
          "value": 4
        },
        {
          "x": 4,
          "y": 3,
          "value": 57
        },
        {
          "x": 5,
          "y": 3,
          "value": 13
        },
        {
          "x": 6,
          "y": 3,
          "value": 94
        },
        {
          "x": 7,
          "y": 3,
          "value": 53
        },
        {
          "x": 0,
          "y": 4,
          "value": 4
        },
        {
          "x": 1,
          "y": 4,
          "value": 9
        },
        {
          "x": 2,
          "y": 4,
          "value": 93
        },
        {
          "x": 3,
          "y": 4,
          "value": 55
        },
        {
          "x": 4,
          "y": 4,
          "value": 55
        },
        {
          "x": 5,
          "y": 4,
          "value": 40
        },
        {
          "x": 6,
          "y": 4,
          "value": 79
        },
        {
          "x": 7,
          "y": 4,
          "value": 40
        },
        {
          "x": 0,
          "y": 5,
          "value": 68
        },
        {
          "x": 1,
          "y": 5,
          "value": 60
        },
        {
          "x": 2,
          "y": 5,
          "value": 62
        },
        {
          "x": 3,
          "y": 5,
          "value": 33
        },
        {
          "x": 4,
          "y": 5,
          "value": 98
        },
        {
          "x": 5,
          "y": 5,
          "value": 67
        },
        {
          "x": 6,
          "y": 5,
          "value": 53
        },
        {
          "x": 7,
          "y": 5,
          "value": 35
        },
        {
          "x": 0,
          "y": 6,
          "value": 27
        },
        {
          "x": 1,
          "y": 6,
          "value": 4
        },
        {
          "x": 2,
          "y": 6,
          "value": 63
        },
        {
          "x": 3,
          "y": 6,
          "value": 99
        },
        {
          "x": 4,
          "y": 6,
          "value": 47
        },
        {
          "x": 5,
          "y": 6,
          "value": 32
        },
        {
          "x": 6,
          "y": 6,
          "value": 26
        },
        {
          "x": 7,
          "y": 6,
          "value": 83
        },
        {
          "x": 0,
          "y": 7,
          "value": 19
        },
        {
          "x": 1,
          "y": 7,
          "value": 65
        },
        {
          "x": 2,
          "y": 7,
          "value": 91
        },
        {
          "x": 3,
          "y": 7,
          "value": 39
        },
        {
          "x": 4,
          "y": 7,
          "value": 81
        },
        {
          "x": 5,
          "y": 7,
          "value": 60
        },
        {
          "x": 6,
          "y": 7,
          "value": 87
        },
        {
          "x": 7,
          "y": 7,
          "value": 34
        }
      ]
    }
  ]
}

Data format

{ x, y, value } + xLabels, yLabels, rowDendrogram, colDendrogram

Data shape

The JSON you pass inside the chart — drop it straight into your series.

data: [
  { x: 0, y: 0, value: 5.2 },
  { x: 1, y: 0, value: 3.8 },
  { x: 0, y: 1, value: 6.1 },
  { x: 1, y: 1, value: 4.5 }
]

Example

KatuCharts.chart('container', {
  series: [{ type: 'clusteredheatmap', data: [{ x:0, y:0, value:5.2 }] }]
});

Type-specific options

Option	Description
`diverging`	Diverging color scale (negative blue, positive red).
`showLabels`	Show row/column labels.
`dendrogramRowWidth / dendrogramColHeight`	Dendrogram sizes.
`rowDendrogram / colDendrogram`	Hierarchical tree objects.

Variations

Diverging scale

Set diverging: true for a blue-white-red scale centered on zero.

KatuCharts.chart('container', {
  series: [{
    type: 'clusteredheatmap', diverging: true,
    data: [{ x: 0, y: 0, value: -2.4 }]
  }]
});

Common errors

Why does my clustered heatmap chart render as a line chart?: The chart type was not registered. KatuCharts logs "KatuCharts: unknown series type "<type>", falling back to line" and draws a line chart rather than throwing. Import the module the type belongs to — for example `import 'katucharts.js/bio';` — before creating the chart.
Why do I get "Cannot read properties of null (reading 'appendChild')"?: The container element does not exist when the chart is created. Create the chart after the element is in the DOM: in React that means inside useEffect, not during render.
Why is the chart rendering with zero height?: The container has no height. A div with no content collapses to zero. Give it a height in CSS, or pass `chart: { height: 400 }` in the options.

FAQ

How do I create a clustered heatmap chart in JavaScript?: Install with `npm install katucharts.js`, import the module with `import 'katucharts.js/bio';`, then call KatuCharts.chart(container, { chart: { type: 'clusteredheatmap' }, series: [...] }).
Why does my clustered heatmap chart render as a line chart?: The chart type was not registered. KatuCharts logs "KatuCharts: unknown series type "<type>", falling back to line" and draws a line chart rather than throwing. Import the module the type belongs to — for example `import 'katucharts.js/bio';` — before creating the chart.
Why do I get "Cannot read properties of null (reading 'appendChild')"?: The container element does not exist when the chart is created. Create the chart after the element is in the DOM: in React that means inside useEffect, not during render.
Why is the chart rendering with zero height?: The container has no height. A div with no content collapses to zero. Give it a height in CSS, or pass `chart: { height: 400 }` in the options.

Common options (color, visible, marker, dataLabels, animation, events, zones…) apply to every type — see Configuration → series. See it rendered in the gallery.