Skip to content

Interface: HeatmapCalc ​

Experimental

heatmap calcdata.

Properties ​

PropertyModifierTypeDescription
fastSmoothingreadonlybooleanExperimental Whether zsmooth: 'fast' applies: not on log axes nor uneven grids (Plotly turns it off there). See heatmapSmoothing.
nxreadonlynumberExperimental
nyreadonlynumberExperimental
pointOfreadonlyInt32Array<ArrayBufferLike> | undefinedExperimental Column data (1D z): per cell, the index of the point placed there (−1 for none), for hover and events. Undefined for 2D z, whose cells are [row, column].
smoothing?readonlyHeatmapSmoothingExperimental Smoothing hover assumes, overriding zsmooth (see heatmapSmoothing): contours set 'best' so labels sit on their grid points. Heatmaps leave it unset.
source?readonlyobjectExperimental 2D z re-indexed by the categories of an axis: the source row / column (of z as given, after transpose) of each grid row / column, −1 for none. Per-cell attributes (text, hovertext, customdata) are read there, so they follow their values. Undefined when the grid is z itself.
source.colsreadonlyInt32Array-
source.rowsreadonlyInt32Array-
xreadonlyHeatmapAxisCellsExperimental
yreadonlyHeatmapAxisCellsExperimental
zreadonlyFloat64ArrayExperimental Cell values, row-major (z[j * nx + i]); NaN for gaps (after connectgaps).
zExtentreadonlyreadonly [number, number]Experimental Finite extent of z ([NaN, NaN] without values).

Released under the MIT License.