Documentation / @ripl/charts / HeatmapChartOptions
Interface: HeatmapChartOptions<TData> ​
Defined in: charts/src/charts/heatmap.ts:91
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:128 |
autoRender? | boolean | Whether the chart renders automatically on construction and after every Chart.update. Defaults to true. | BaseChartOptions.autoRender | charts/src/core/chart.ts:122 |
axis? | ChartAxisInput<TData> | Axis configuration for the x and y axes. | - | charts/src/charts/heatmap.ts:115 |
borderRadius? | number | Corner radius in pixels applied to each cell. Defaults to 2. | - | charts/src/charts/heatmap.ts:107 |
data | TData[] | The dataset rendered as a grid of cells. | - | charts/src/charts/heatmap.ts:93 |
description? | string | Accessible description announced by screen readers (sets the rendering element's ARIA label). Defaults to the title text. | BaseChartOptions.description | charts/src/core/chart.ts:132 |
format? | ValueFormatInput | How cell values are formatted in the tooltip and legend: a built-in format type, Intl options, or a custom function. | - | charts/src/charts/heatmap.ts:111 |
gradient? | string[] | Color stops (low→high) interpolated across the value extent; also accepts a built-in palette. | - | charts/src/charts/heatmap.ts:105 |
keyX | keyof TData | ((item) => string) | Accessor for each item's x-axis category. | - | charts/src/charts/heatmap.ts:95 |
keyY | keyof TData | ((item) => string) | Accessor for each item's y-axis category. | - | charts/src/charts/heatmap.ts:97 |
labels? | ChartDataLabelsInput | Show each cell's value centered in the cell (true/false or detailed label options). Label color auto-contrasts against the cell color. Off by default. | - | charts/src/charts/heatmap.ts:117 |
legend? | boolean | ColorLegendOptions | Gradient color legend showing the value→color scale. Shown by default; pass false to hide, or an options object to customize. | - | charts/src/charts/heatmap.ts:109 |
padding? | PaddingInput | Space reserved around the chart, in pixels. A single number applies to all four edges; a [top, right, bottom, left] tuple or a partial { top, right, bottom, left } object sets individual edges, leaving unspecified edges at the default. Defaults to 16. | BaseChartOptions.padding | charts/src/core/chart.ts:124 |
theme? | string | Theme | Theme for this chart: a registered name ('light'/'dark'/'auto'), or a Theme. Falls back to the module default (see setDefaultTheme). | BaseChartOptions.theme | charts/src/core/chart.ts:130 |
title? | string | Partial<ChartTitleOptions> | Chart title as plain text, or a ChartTitleOptions object for full control. | BaseChartOptions.title | charts/src/core/chart.ts:126 |
tooltip? | ChartTooltipInput | Hover tooltip configuration (true/false or detailed tooltip options). | - | charts/src/charts/heatmap.ts:113 |
value | NumericAccessor<TData> | Accessor for each cell's numeric value (drives its color). | - | charts/src/charts/heatmap.ts:99 |
xCategories | string[] | Ordered list of categories along the x axis. | - | charts/src/charts/heatmap.ts:101 |
yCategories | string[] | Ordered list of categories along the y axis. | - | charts/src/charts/heatmap.ts:103 |