PitchKit
API Reference@pitchkit/coreInterfaces

PitchDimensions

Defined in: packages/core/src/dimensions/types.ts:34

Encodes a provider's coordinate system: extent, origin corner, y-axis direction, and whether coordinates are normalized (e.g. Opta's 0-100 scale), per PRD §8.2.

Display orientation (horizontal/vertical) is deliberately NOT part of this model — it's a Viewport/display concern, not a fact about the provider's coordinate system.

Properties

PropertyModifierTypeDescriptionDefined in
lengthreadonlynumberFull pitch extent in provider units (along the x-axis).packages/core/src/dimensions/types.ts:37
markingsreadonlyPitchMarkings-packages/core/src/dimensions/types.ts:52
normalizedreadonlybooleanTrue for percentage-style normalized grids (e.g. Opta's 0-100).packages/core/src/dimensions/types.ts:43
originreadonlyPitchOrigin-packages/core/src/dimensions/types.ts:40
pitchTypereadonlyPitchTypeId-packages/core/src/dimensions/types.ts:35
realLengthMetersreadonlynumberApproximate real-world pitch size this provider's grid is calibrated against. Used only for documentation / sanity-check conversions — not an exact per-axis scale for every provider (e.g. Opta's circle_diameter constant is not axis-aware, so width-axis conversions of circular markings are approximate by design).packages/core/src/dimensions/types.ts:50
realWidthMetersreadonlynumber-packages/core/src/dimensions/types.ts:51
widthreadonlynumberFull pitch extent in provider units (along the y-axis).packages/core/src/dimensions/types.ts:39
yDirectionreadonlyYDirection-packages/core/src/dimensions/types.ts:41

On this page