PitchKit
API Reference@pitchkit/coreInterfaces

FlowLayer

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

Aggregated movement/pass data, binned by start location into a grid and rendered as one arrow per occupied bin, sized/colored by that bin's volume (mplsoccer's flow).

Type Parameters

Type ParameterDefault type
Tunknown

Properties

PropertyModifierTypeDescriptionDefined in
binsX?readonlynumber-packages/core/src/scene/types.ts:208
binsY?readonlynumber-packages/core/src/scene/types.ts:209
className?readonlystringApplied as every arrow's class attribute; styling escape hatch (PRD §8.7).packages/core/src/scene/types.ts:219
colorMax?readonlystringColor at the highest bin count in the layer's data.packages/core/src/scene/types.ts:213
colorMin?readonlystringColor at the lowest bin count in the layer's data.packages/core/src/scene/types.ts:211
datareadonlyreadonly T[]-packages/core/src/scene/types.ts:203
strokeWidthMax?readonlynumberArrow stroke width at the highest bin count.packages/core/src/scene/types.ts:217
strokeWidthMin?readonlynumberArrow stroke width at the lowest bin count.packages/core/src/scene/types.ts:215
typereadonly"flow"-packages/core/src/scene/types.ts:202
xreadonlyAccessor<T, number>-packages/core/src/scene/types.ts:204
x2readonlyAccessor<T, number>-packages/core/src/scene/types.ts:206
yreadonlyAccessor<T, number>-packages/core/src/scene/types.ts:205
y2readonlyAccessor<T, number>-packages/core/src/scene/types.ts:207

On this page