PitchKit
API Reference@pitchkit/coreInterfaces

PitchAppearance

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

Non-coordinate visual treatment of the pitch surface (the stripes and goal-type styling knobs; see docs/architecture.md#theming-and-styling). Deliberately separate from PitchDimensions (a fact about the provider's coordinate system) and from CSS variables (the colours themselves) — this only toggles which shapes get painted.

Properties

PropertyModifierTypeDescriptionDefined in
goalType?readonlyGoalType-packages/core/src/scene/types.ts:318
linesOnTop?readonlybooleanPaint the pitch markings above the layers rather than below them — mplsoccer's line_zorder. Off by default, so SVG marks (a scatter dot on the penalty spot, an arrow crossing the halfway line) sit on top of the lines, which is what you want for discrete marks. Turn it on for the density layers: an opaque heatmap/ positionalHeatmap/hexbin/kde fill covers the whole pitch and would otherwise hide the markings underneath it — the same masking problem opaque stripes caused for the outline in issue #14, one level up. Only the markings move; the grass surface and stripes always stay at the bottom.packages/core/src/scene/types.ts:334
stripes?readonlyPitchStripes-packages/core/src/scene/types.ts:317

On this page