Skip to content

Interface: HeatmapData ​

Experimental

Data for HeatmapPrimitive.

Properties ​

PropertyTypeDescription
colorscaleColorscaleExperimental sRGB 0–1 stops (shared LUT texture).
interpolationColorscaleInterpolationExperimental Space the LUT interpolates stops in. Default 'rgb'.
nxnumberExperimental
nynumberExperimental
opacitynumberExperimental Multiplies alpha (uniform). Default 1.
reversescalebooleanExperimental Uniform. Default false.
smoothingHeatmapSmoothingExperimental Uniform. Default false.
xEdgesArrayLike<number>Experimental Cell edges in LINEAR data coordinates (caller already applied log10 / category index): nx + 1 values, strictly monotonic, ascending or descending. Anything else hides the heatmap.
xgapnumberExperimental Gaps between cells in CSS px (Plotly xgap / ygap), only applied without smoothing. Default 0.
yEdgesArrayLike<number>Experimental ny + 1 edges, same rules.
ygapnumberExperimental
zArrayLike<number>Experimental Row-major values: z[j * nx + i] is column i (x) of row j (y). Non-finite = transparent.
zmaxnumberExperimental Value at colorscale 1 (uniform). Default: max finite z (1 when none).
zminnumberExperimental Value at colorscale 0 (uniform). Default: min finite z (0 when none).
zRange?readonly [number, number]Experimental Finite [min, max] of z when the caller already knows it: saves a pass over the values on upload (large grids). Must be given again with each new z. Default: computed.

Released under the MIT License.