TypeScript SDK Reference / HeatmapOptions

Interface: HeatmapOptions

Options for configuring the heatmap visualization. Pass to the HeatmapRenderer constructor or to updateOptions().

Properties

enabled?

optional enabled: boolean

Enable or disable the heatmap overlay. Default true.

---

mode?

optional mode: HeatmapPresetName | HeatmapVariantConfig

Select the heatmap variant.

• A HeatmapPresetName string selects a built-in preset.
• A HeatmapVariantConfig object applies a fully custom configuration. Default: "field".

---

ppgHistorySize?

optional ppgHistorySize: number

Number of PPG signal samples to keep for amplitude normalization. Larger values produce smoother color changes. Default: 120.

---

renderFps?

optional renderFps: number

Target render frame rate for the heatmap canvas. Default: 30.