PitchKit
API Reference@pitchkit/reactInterfaces

HeatmapProps

Defined in: packages/react/src/Heatmap.tsx:7

Extends

Type Parameters

Type Parameter
T

Properties

PropertyModifierTypeDescriptionInherited fromDefined in
binsX?readonlynumber-Omit.binsXpackages/core/src/scene/types.ts:100
binsY?readonlynumber-Omit.binsYpackages/core/src/scene/types.ts:101
className?publicstringEvery bin gets painted (from colorMin to colorMax, including zero-value bins) rather than leaving low bins transparent, so a heatmap fully covers the pitch underneath by default. Set an opacity here (or a blend mode) to let the pitch show through.-packages/react/src/Heatmap.tsx:14
colorMax?readonlystringColor at the highest bin value in the scene's data.Omit.colorMaxpackages/core/src/scene/types.ts:105
colorMin?readonlystringColor at the lowest bin value in the scene's data.Omit.colorMinpackages/core/src/scene/types.ts:103
datareadonlyreadonly T[]-Omit.datapackages/core/src/scene/types.ts:95
style?publicCSSProperties--packages/react/src/Heatmap.tsx:15
weight?readonlyAccessor<T, number>Omitted = count of points per bin; provided = sum of this per bin.Omit.weightpackages/core/src/scene/types.ts:99
xreadonlyAccessor<T, number>-Omit.xpackages/core/src/scene/types.ts:96
yreadonlyAccessor<T, number>-Omit.ypackages/core/src/scene/types.ts:97

On this page