Charts · Points & grids

HeatmapChart

Labelled rows of values, normalised against `scaleMax`. Family: Points & grids · chart 18 of 60.

Load by day and hour
label	00	04	08	12	16	20
Mon	12	34	58	71	66	40
Tue	18	42	77	88	70	35
Wed	9	38	64	93	81	47
Thu	15	29	55	68	59	31
Fri	6	21	43	49	37	14

Report an issue with this chart

Load by day and hour
label	00	04	08	12	16	20
Mon	12	34	58	71	66	40
Tue	18	42	77	88	70	35
Wed	9	38	64	93	81	47
Thu	15	29	55	68	59	31
Fri	6	21	43	49	37	14

mode="precision"

Load by day and hour
label	00	04	08	12	16	20
Mon	12	34	58	71	66	40
Tue	18	42	77	88	70	35
Wed	9	38	64	93	81	47
Thu	15	29	55	68	59	31
Fri	6	21	43	49	37	14

substrate="green"

Load by day and hour
label	00	04	08	12	16	20
Mon	12	34	58	71	66	40
Tue	18	42	77	88	70	35
Wed	9	38	64	93	81	47
Thu	15	29	55	68	59	31
Fri	6	21	43	49	37	14

ground="cyanotype"

Example

The chart above, in each framework. Pick a framework once and every example on the site follows it.

shell

npm install @silverpoint/react @silverpoint/grounds @silverpoint/fonts

tsx

import '@silverpoint/fonts/fonts.css';
import '@silverpoint/grounds/styles.css';
import { HeatmapChart } from '@silverpoint/react/heatmap-chart';

const data = [
  { label: 'Mon', values: [12, 34, 58, 71, 66, 40] },
  { label: 'Tue', values: [18, 42, 77, 88, 70, 35] },
  { label: 'Wed', values: [9, 38, 64, 93, 81, 47] },
  { label: 'Thu', values: [15, 29, 55, 68, 59, 31] },
  { label: 'Fri', values: [6, 21, 43, 49, 37, 14] },
];

export default function App() {
  return (
    <div style={{ width: 480 }}>
      <HeatmapChart
        data={data}
        labelKey="label"
        valuesKey="values"
        columnLabels={['00', '04', '08', '12', '16', '20']}
        title="Load by day and hour"
      />
    </div>
  );
}

shell

npm install @silverpoint/vue @silverpoint/grounds @silverpoint/fonts

vue

<script setup lang="ts">
import '@silverpoint/fonts/fonts.css';
import '@silverpoint/grounds/styles.css';
import { SpHeatmapChart } from '@silverpoint/vue/heatmap-chart';

const data = [
  { label: 'Mon', values: [12, 34, 58, 71, 66, 40] },
  { label: 'Tue', values: [18, 42, 77, 88, 70, 35] },
  { label: 'Wed', values: [9, 38, 64, 93, 81, 47] },
  { label: 'Thu', values: [15, 29, 55, 68, 59, 31] },
  { label: 'Fri', values: [6, 21, 43, 49, 37, 14] },
];
</script>

<template>
  <div style="width: 480px">
    <SpHeatmapChart
      :data="data"
      label-key="label"
      values-key="values"
      :column-labels="['00', '04', '08', '12', '16', '20']"
      title="Load by day and hour"
    />
  </div>
</template>

shell

npm install @silverpoint/angular @silverpoint/grounds @silverpoint/fonts

// src/styles.css:
//   @import '@silverpoint/fonts/fonts.css';
//   @import '@silverpoint/grounds/styles.css';

import { Component } from '@angular/core';
import { SpHeatmapChart } from '@silverpoint/angular/heatmap-chart';

@Component({
  selector: 'app-root',
  imports: [SpHeatmapChart],
  template: `
    <div style="width: 480px">
      <sp-heatmap-chart
        [data]="data"
        labelKey="label"
        valuesKey="values"
        [columnLabels]="['00', '04', '08', '12', '16', '20']"
        title="Load by day and hour"
      />
    </div>
  `,
})
export class App {
  protected readonly data = [
    { label: 'Mon', values: [12, 34, 58, 71, 66, 40] },
    { label: 'Tue', values: [18, 42, 77, 88, 70, 35] },
    { label: 'Wed', values: [9, 38, 64, 93, 81, 47] },
    { label: 'Thu', values: [15, 29, 55, 68, 59, 31] },
    { label: 'Fri', values: [6, 21, 43, 49, 37, 14] },
  ];
}

shell

pip install reflex-silverpoint-react

python

import reflex as rx
from reflex_silverpoint_react import heatmap_chart

DATA = [
    {"label": "Mon", "values": [12, 34, 58, 71, 66, 40]},
    {"label": "Tue", "values": [18, 42, 77, 88, 70, 35]},
    {"label": "Wed", "values": [9, 38, 64, 93, 81, 47]},
    {"label": "Thu", "values": [15, 29, 55, 68, 59, 31]},
    {"label": "Fri", "values": [6, 21, 43, 49, 37, 14]},
]


def index() -> rx.Component:
    return rx.box(
        heatmap_chart(
            data=DATA,
            label_key="label",
            values_key="values",
            column_labels=["00", "04", "08", "12", "16", "20"],
            title="Load by day and hour",
        ),
        width="480px",
    )


app = rx.App()
app.add_page(index)

Import

Each chart has its own subpath, so a bundle only carries the charts it uses. Every adapter also exports every chart from its barrel.

Framework	Import
React	`import { HeatmapChart } from '@silverpoint/react/heatmap-chart';`
Vue	`import { SpHeatmapChart } from '@silverpoint/vue/heatmap-chart';`
Angular	`import { SpHeatmapChart } from '@silverpoint/angular/heatmap-chart'; // <sp-heatmap-chart>`
Reflex	`from reflex_silverpoint_react import heatmap_chart`

Props

The props HeatmapChart adds to the ones every chart takes. Accessor props (…Key, keys, names) name fields of your rows and are ignored without data.

React / Angular	Vue	Reflex	Type	Description
`labelKey`	`label-key`	`label_key`	`Accessor<string>`	—
`valuesKey`	`values-key`	`values_key`	`Accessor<readonly (number \| null)[] \| null \| undefined>`	—
`scaleMax`	`scale-max`	`scale_max`	`number`	Value that maps to the darkest tone; 100 by default.
`columnLabels`	`column-labels`	`column_labels`	`readonly string[]`	Names of the columns, in order; missing ones fall back to `#k` (delta-006).

Common props

Every chart also takes these. Framework conventions: camelCase in React and Angular, kebab-case in Vue templates, snake_case in Reflex. Read more about them.

Show the 22 common props

React / Angular	Vue	Reflex	Type	Description
`data`	`data`	`data`	`readonly Datum[]`	Rows to draw. If omitted, the demo dataset is rendered (REQ-093) and the accessor props (`…_key`, `keys`, `names`) are ignored.
`ground`	`ground`	`ground`	`GroundRef`	Style ground: `silverpoint` or `cyanotype`, or a ground object. Defaults to the app provider's, or `silverpoint`.
`substrate`	`substrate`	`substrate`	`SubstrateName`	Prepared substrate within the ground (REQ-046).
`mode`	`mode`	`mode`	`InkMode`	`ink` by default; `precision` disables inking (REQ-021).
`seed`	`seed`	`seed`	`Seed`	Seed. If omitted, it is derived from `id` stably (REQ-003).
`id`	`id`	`id`	`string`	Stable identifier. If omitted, it is generated deterministically.
`height`	`height`	`height`	`number`	Height of the drawing area in px. Width is the container's unless pinned.
`width`	`width`	`width`	`number`	—
`chrome`	`chrome`	`chrome`	`'card' \| 'bare'`	`card` draws the full frame; `bare` only the drawing area (REQ-095).
`hatchFill`	`hatch-fill`	`hatch_fill`	`'tile' \| 'per-shape'`	How areas are filled (REQ-029).
`title`	`title`	`title`	`string`	—
`badge`	`badge`	`badge`	`string`	—
`value`	`value`	`value`	`string \| number`	—
`unit`	`unit`	`unit`	`string`	—
`footerLeft`	`footer-left`	`footer_left`	`string`	—
`footerRight`	`footer-right`	`footer_right`	`string`	—
`label`	`label`	`label`	`string`	Accessible name. If omitted, it is derived from `title` (REQ-120).
`description`	`description`	`description`	`string`	Long description for screen readers (REQ-120).
`dataTable`	`data-table`	`data_table`	`'visible' \| 'hidden' \| 'none'`	Tabular alternative; `hidden` leaves it for assistive technology only (REQ-121).
`locale`	`locale`	`locale`	`string`	—
`numberFormat`	`number-format`	`number_format`	`Intl.NumberFormatOptions`	—
`className`	`class-name`	`class_name`	`string`	—

Pointer and keyboard exploration are built in. The item under the pointer or focus is reported, and a click, Enter or Space selects it. The item is { seriesKey, index, datum, value, point: { x, y } }.

Framework	Active item	Selection	Custom readout
React	`onActiveChange`	`onSelect`	`tooltip={(item, readout) => …}`
Vue	`@active-change`	`@select`	`<template #tooltip>`
Angular	`(activeChange)`	`(select)`	`<ng-template spTooltip>`
Reflex	`on_active_change`	`on_select`	`tooltip=tooltip_template(…)`

Interaction and readouts →

Report it

Found something wrong with HeatmapChart? Open an issue on GitHub — the form comes pre-filled with the chart and the version.

label	00	04	08	12	16	20
Mon	12	34	58	71	66	40
Tue	18	42	77	88	70	35
Wed	9	38	64	93	81	47
Thu	15	29	55	68	59	31
Fri	6	21	43	49	37	14

label	00	04	08	12	16	20
Mon	12	34	58	71	66	40
Tue	18	42	77	88	70	35
Wed	9	38	64	93	81	47
Thu	15	29	55	68	59	31
Fri	6	21	43	49	37	14

label	00	04	08	12	16	20
Mon	12	34	58	71	66	40
Tue	18	42	77	88	70	35
Wed	9	38	64	93	81	47
Thu	15	29	55	68	59	31
Fri	6	21	43	49	37	14

label	00	04	08	12	16	20
Mon	12	34	58	71	66	40
Tue	18	42	77	88	70	35
Wed	9	38	64	93	81	47
Thu	15	29	55	68	59	31
Fri	6	21	43	49	37	14

label	00	04	08	12	16	20
Mon	12	34	58	71	66	40
Tue	18	42	77	88	70	35
Wed	9	38	64	93	81	47
Thu	15	29	55	68	59	31
Fri	6	21	43	49	37	14

label	00	04	08	12	16	20
Mon	12	34	58	71	66	40
Tue	18	42	77	88	70	35
Wed	9	38	64	93	81	47
Thu	15	29	55	68	59	31
Fri	6	21	43	49	37	14

label	00	04	08	12	16	20
Mon	12	34	58	71	66	40
Tue	18	42	77	88	70	35
Wed	9	38	64	93	81	47
Thu	15	29	55	68	59	31
Fri	6	21	43	49	37	14

label	00	04	08	12	16	20
Mon	12	34	58	71	66	40
Tue	18	42	77	88	70	35
Wed	9	38	64	93	81	47
Thu	15	29	55	68	59	31
Fri	6	21	43	49	37	14

HeatmapChart

Example

Import

Props

Common props

Events

label	00	04	08	12	16	20
Mon	12	34	58	71	66	40
Tue	18	42	77	88	70	35
Wed	9	38	64	93	81	47
Thu	15	29	55	68	59	31
Fri	6	21	43	49	37	14

label	00	04	08	12	16	20
Mon	12	34	58	71	66	40
Tue	18	42	77	88	70	35
Wed	9	38	64	93	81	47
Thu	15	29	55	68	59	31
Fri	6	21	43	49	37	14

label	00	04	08	12	16	20
Mon	12	34	58	71	66	40
Tue	18	42	77	88	70	35
Wed	9	38	64	93	81	47
Thu	15	29	55	68	59	31
Fri	6	21	43	49	37	14

label	00	04	08	12	16	20
Mon	12	34	58	71	66	40
Tue	18	42	77	88	70	35
Wed	9	38	64	93	81	47
Thu	15	29	55	68	59	31
Fri	6	21	43	49	37	14