Skip to content

Function: sampleHeatmapAxes() ​

ts
function sampleHeatmapAxes(data, xAxis, yAxis, x, y, transform?): number;

Experimental

sampleHeatmap with prebuilt axes (for repeated lookups, e.g. hover).

Parameters ​

ParameterTypeDefault value
dataPick<HeatmapData, "z"> & Partial<Pick<HeatmapData, "smoothing" | "xgap" | "ygap">>undefined
xAxisHeatmapAxisundefined
yAxisHeatmapAxisundefined
xnumberundefined
ynumberundefined
transformDataTransformIDENTITY_TRANSFORM

Returns ​

number

Released under the MIT License.