PitchKit
API Reference@pitchkit/reactInterfaces

RaceChartProps

Defined in: packages/react/src/race-types.ts:50

Type Parameters

Type Parameter
T

Properties

PropertyModifierTypeDescriptionDefined in
appearance?readonlyRaceAppearance-packages/react/src/race-types.ts:73
aspectRatio?readonlynumberShape of the responsive box. Default 2, or 1.4 below 420px widepackages/react/src/race-types.ts:70
children?readonlyReactNodeAnnotations, positioned through useRaceChart().packages/react/src/race-types.ts:78
className?readonlystring-packages/react/src/race-types.ts:76
emphasise?readonlyAccessor<T, boolean>Drawn with the larger ringed marker. For an xG race, pass isGoal.packages/react/src/race-types.ts:57
endTime?readonlynumberWhere the x-axis ends. Defaults to max(90, ceil(latest event)).packages/react/src/race-types.ts:62
height?readonlynumber-packages/react/src/race-types.ts:68
maxValue?readonlynumberTop of the y-axis. Defaults to a round ceiling above the highest total.packages/react/src/race-types.ts:64
padding?readonlyChartPadding-packages/react/src/race-types.ts:71
period?readonlyAccessor<T, number>Given, period-boundary rules are derived from the data rather than assumed.packages/react/src/race-types.ts:59
seriesreadonlyreadonly RaceSeries<T>[]-packages/react/src/race-types.ts:51
timereadonlyAccessor<T, number>Match minute. Fractional is fine — (s) => s.minute + s.second / 60.packages/react/src/race-types.ts:53
tooltip?readonly(rows, time) => ReactNodeReplaces the default crosshair tooltip body.packages/react/src/race-types.ts:75
valuereadonlyAccessor<T, number>The quantity that accumulates. For an xG race, the shot's xG.packages/react/src/race-types.ts:55
width?readonlynumberFixed pixel size — the opt-out from the responsive default. Provide both, or neither.packages/react/src/race-types.ts:67

On this page