API / Series/Heatmap / HeatmapSeries
Defined in: src/core/types/chart/heatmap.ts:28
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
T |
MeaningfulAny |
Properties
| Property | Type | Description |
|---|---|---|
borderColor? |
string |
The color of the border surrounding each cell. |
borderWidth? |
number |
The width of the border surrounding each cell. Default 0 |
color? |
string |
The main color of the series (hex, rgba) |
cursor? |
string |
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked. |
custom? |
any |
A reserved subspace to store options and values for customized functionality Here you can add additional data for your own event callbacks and formatter callbacks |
data |
HeatmapSeriesData<T>[] |
- |
dataLabels? |
BaseDataLabels |
Options for the series data labels, appearing next to each data point. |
legend? |
BaseSeriesLegend & object |
Individual series legend options. Has higher priority than legend options in widget data |
name |
string |
The name of the series (used in legend, tooltip etc) |
nullMode? |
"zero" | "skip" |
Specifies how null or undefined values should be handled in the series. - 'zero': Treat null values as zero - 'skip': Omit data points with null values (show gaps) Default 'skip' |
tooltip? |
object |
Options for the tooltip that appears when the user hovers over a series or point. |
tooltip.enabled? |
boolean |
Enable or disable the visibility of this series in the tooltip. Default true |
tooltip.valueFormat? |
ValueFormat |
Formatting settings for tooltip value. |
type |
"heatmap" |
- |
visible? |
boolean |
Initial visibility of the series |
Previous