PitchKit
API Reference@pitchkit/coreInterfaces

HexbinLayer

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

Hexagonally-binned density (mplsoccer's hexbin): the same aggregation as HeatmapLayer over a hexagonal lattice, which packs more evenly than a square grid and so shows less axis-aligned banding. Canvas-rendered.

Type Parameters

Type ParameterDefault type
Tunknown

Properties

PropertyModifierTypeDescriptionDefined in
binsX?readonlynumberHexagon columns across the pitch length; the cell size follows from it.packages/core/src/scene/types.ts:150
colorMax?readonlystring-packages/core/src/scene/types.ts:152
colorMin?readonlystring-packages/core/src/scene/types.ts:151
datareadonlyreadonly T[]-packages/core/src/scene/types.ts:144
stroke?readonlystringStroke colour for hexagon outlines; omitted = no outlines.packages/core/src/scene/types.ts:154
strokeWidth?readonlynumber-packages/core/src/scene/types.ts:155
typereadonly"hexbin"-packages/core/src/scene/types.ts:143
weight?readonlyAccessor<T, number>Omitted = count of points per hexagon; provided = sum of this per hexagon.packages/core/src/scene/types.ts:148
xreadonlyAccessor<T, number>-packages/core/src/scene/types.ts:145
yreadonlyAccessor<T, number>-packages/core/src/scene/types.ts:146

On this page