Skip to content

TypeScript SDK Reference / HeatmapVariantConfig

Interface: HeatmapVariantConfig ​

Configuration object that fully defines a heatmap variant. Pass a custom object via HeatmapOptions.mode for full control, or use a preset name to reference a built-in configuration.

Properties ​

aCenter ​

aCenter: number

Alpha at the center of each radial gradient hotspot.


aEdge ​

aEdge: number

Alpha at the 70% falloff point.


aMid ​

aMid: number

Alpha at the 30% falloff point.


colormap ​

colormap: HeatmapColormap

Color mapping function. Receives a normalized value [0, 1] and returns an RGB triplet [r, g, b] where each channel is 0–255.


cycleSpeed ​

cycleSpeed: number

Speed of color cycling oscillation (0 = static).


driftAmp ​

driftAmp: number

Amplitude of positional drift for hotspot centers, in face-height units (0 = no drift).


flickerAmp ​

flickerAmp: number

Amplitude of high-frequency intensity flicker (0 = no flicker).


pulseAmp ​

pulseAmp: number

Amplitude of sinusoidal intensity pulsing (0 = no pulse).


pulseSpeed ​

pulseSpeed: number

Frequency of the pulse animation.


radiusScale ​

radiusScale: number

Multiplier on the base hotspot radius (1 = default).