PitchKit
API Reference@pitchkit/reactInterfaces

FlowProps

Defined in: packages/react/src/Flow.tsx:6

Extends

Type Parameters

Type Parameter
T

Properties

PropertyModifierTypeDescriptionInherited fromDefined in
binsX?readonlynumber-Omit.binsXpackages/core/src/scene/types.ts:208
binsY?readonlynumber-Omit.binsYpackages/core/src/scene/types.ts:209
className?readonlystringApplied as every arrow's class attribute; styling escape hatch (PRD §8.7).Omit.classNamepackages/core/src/scene/types.ts:219
colorMax?readonlystringColor at the highest bin count in the layer's data.Omit.colorMaxpackages/core/src/scene/types.ts:213
colorMin?readonlystringColor at the lowest bin count in the layer's data.Omit.colorMinpackages/core/src/scene/types.ts:211
datareadonlyreadonly T[]-Omit.datapackages/core/src/scene/types.ts:203
strokeWidthMax?readonlynumberArrow stroke width at the highest bin count.Omit.strokeWidthMaxpackages/core/src/scene/types.ts:217
strokeWidthMin?readonlynumberArrow stroke width at the lowest bin count.Omit.strokeWidthMinpackages/core/src/scene/types.ts:215
tooltip?public(bin, i) => ReactNodePer-bin (not per-datum) — the rendered arrows are aggregates, one per occupied grid cell.-packages/react/src/Flow.tsx:8
xreadonlyAccessor<T, number>-Omit.xpackages/core/src/scene/types.ts:204
x2readonlyAccessor<T, number>-Omit.x2packages/core/src/scene/types.ts:206
yreadonlyAccessor<T, number>-Omit.ypackages/core/src/scene/types.ts:205
y2readonlyAccessor<T, number>-Omit.y2packages/core/src/scene/types.ts:207

On this page