Documentation / @ripl/charts / HeatmapChartOptions
Interface: HeatmapChartOptions<TData>
Defined in: charts/src/charts/heatmap.ts:68
Options for configuring a HeatmapChart.
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
TData | unknown |
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
animation? | boolean | Partial<ChartAnimationOptions> | Animation configuration, or a boolean toggling all transitions. See ChartAnimationOptions. | BaseChartOptions.animation | charts/src/core/chart.ts:89 |
autoRender? | boolean | Whether the chart renders automatically on construction and after every Chart.update. Defaults to true. | BaseChartOptions.autoRender | charts/src/core/chart.ts:83 |
axis? | ChartAxisInput<TData> | Axis configuration for the x and y axes. | - | charts/src/charts/heatmap.ts:88 |
borderRadius? | number | Corner radius in pixels applied to each cell. Defaults to 2. | - | charts/src/charts/heatmap.ts:84 |
colorRange? | string[] | Colour stops (low→high) interpolated across the value extent; also accepts a built-in palette. | - | charts/src/charts/heatmap.ts:82 |
data | TData[] | The dataset rendered as a grid of cells. | - | charts/src/charts/heatmap.ts:70 |
padding? | Partial<ChartPadding> | Space reserved around the chart, per edge, in pixels. | BaseChartOptions.padding | charts/src/core/chart.ts:85 |
title? | string | Partial<ChartTitleOptions> | Chart title as plain text, or a ChartTitleOptions object for full control. | BaseChartOptions.title | charts/src/core/chart.ts:87 |
tooltip? | ChartTooltipInput | Hover tooltip configuration (true/false or detailed tooltip options). | - | charts/src/charts/heatmap.ts:86 |
value | NumericAccessor<TData> | Accessor for each cell's numeric value (drives its colour). | - | charts/src/charts/heatmap.ts:76 |
xBy | keyof TData | ((item) => string) | Accessor for each item's x-axis category. | - | charts/src/charts/heatmap.ts:72 |
xCategories | string[] | Ordered list of categories along the x axis. | - | charts/src/charts/heatmap.ts:78 |
yBy | keyof TData | ((item) => string) | Accessor for each item's y-axis category. | - | charts/src/charts/heatmap.ts:74 |
yCategories | string[] | Ordered list of categories along the y axis. | - | charts/src/charts/heatmap.ts:80 |