PitchKit
API Reference@pitchkit/coreInterfaces

FlowLayer

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

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:289
binsY?readonlynumber-packages/core/src/scene/types.ts:290
className?readonlystringApplied as every arrow's class attribute; styling escape hatch (docs/architecture.md#theming-and-styling).packages/core/src/scene/types.ts:300
colorMax?readonlystringColor at the highest bin count in the layer's data.packages/core/src/scene/types.ts:294
colorMin?readonlystringColor at the lowest bin count in the layer's data.packages/core/src/scene/types.ts:292
datareadonlyreadonly T[]-packages/core/src/scene/types.ts:284
strokeWidthMax?readonlynumberArrow stroke width at the highest bin count.packages/core/src/scene/types.ts:298
strokeWidthMin?readonlynumberArrow stroke width at the lowest bin count.packages/core/src/scene/types.ts:296
typereadonly"flow"-packages/core/src/scene/types.ts:283
xreadonlyAccessor<T, number>-packages/core/src/scene/types.ts:285
x2readonlyAccessor<T, number>-packages/core/src/scene/types.ts:287
yreadonlyAccessor<T, number>-packages/core/src/scene/types.ts:286
y2readonlyAccessor<T, number>-packages/core/src/scene/types.ts:288

On this page