PitchKit
API Reference@pitchkit/coreInterfaces

HeatmapLayer

Defined in: packages/core/src/scene/types.ts:93

Binned aggregate marks: divides the pitch into a binsX x binsY grid and colors each cell by point count (default) or, if weight is given, the sum of that weight per cell (e.g. total xG per zone). Rendered via the Canvas path (PRD §8.1) — SVG's per-element DOM cost doesn't scale to dense raster data the way a handful of fillRect calls does.

Type Parameters

Type ParameterDefault type
Tunknown

Properties

PropertyModifierTypeDescriptionDefined in
binsX?readonlynumber-packages/core/src/scene/types.ts:100
binsY?readonlynumber-packages/core/src/scene/types.ts:101
colorMax?readonlystringColor at the highest bin value in the scene's data.packages/core/src/scene/types.ts:105
colorMin?readonlystringColor at the lowest bin value in the scene's data.packages/core/src/scene/types.ts:103
datareadonlyreadonly T[]-packages/core/src/scene/types.ts:95
typereadonly"heatmap"-packages/core/src/scene/types.ts:94
weight?readonlyAccessor<T, number>Omitted = count of points per bin; provided = sum of this per bin.packages/core/src/scene/types.ts:99
xreadonlyAccessor<T, number>-packages/core/src/scene/types.ts:96
yreadonlyAccessor<T, number>-packages/core/src/scene/types.ts:97

On this page