Skip to main content

Interface: SurfaceOpts

Defined in: packages/sdvplot/src/plot/surface.ts:12

Sporty's surface options plus team painting; colorUpdates overrides are keyed by sporty colour keys.

Extends​

  • SurfaceSceneOptions

Properties​

arcResolution?​

optional arcResolution?: number

Defined in: packages/sdvplot/src/surfaces.ts:112

Inherited from​

SurfaceSceneOptions.arcResolution

optional centerLogo?: number | boolean

Defined in: packages/sdvplot/src/plot/surface.ts:17

A team logo at the surface centre (0, 0): true is 0.25 of the frame height, a number is that fraction in (0, 1] (0 or out of range throws InputError). Ignored without a team. xTrans/yTrans or a half-court displayRange can move (0, 0) off-frame.

colorUpdates?​

optional colorUpdates?: Partial<Record<"plot_background" | "court_apron" | "center_circle_outline" | "center_circle_fill" | "division_line" | "endline" | "sideline" | "two_point_range" | "three_point_line" | "painted_area" | "lane_space_mark" | "free_throw_circle_fill" | "free_throw_circle_dash" | "restricted_arc" | "inbounding_line" | "substitution_line" | "team_bench_line" | "backboard" | "basket_ring" | "net" | "offensive_half_court" | "defensive_half_court" | "lane_boundary" | "free_throw_circle_outline" | "baseline_lower_defensive_box" | "lane_lower_defensive_box" | "field_apron" | "end_line" | "field_border" | "field_border_outline" | "red_zone_border" | "red_zone_border_outline" | "goal_line" | "major_yard_line" | "minor_yard_line" | "try_mark" | "coaching_box_line" | "directional_arrow" | "restricted_area" | "coaching_box" | "team_bench_area" | "team_bench_area_outline" | "yardage_marker" | "offensive_half" | "defensive_half" | "offensive_endzone" | "defensive_endzone" | "boards" | "center_line" | "referee_crease" | "zone_line" | "center_faceoff_spot" | "goal_crease_outline" | "goal_crease_fill" | "center_faceoff_circle" | "odzone_faceoff_circle" | "goal_frame" | "off_ice_officials_box" | "ozone_ice" | "nzone_ice" | "dzone_ice" | "restricted_trapezoid" | "faceoff_spot_ring" | "faceoff_spot_stripe" | "faceoff_line" | "goal_fill" | "team_a_bench" | "team_b_bench" | "team_a_penalty_box" | "team_b_penalty_box", string>>

Defined in: packages/sdvplot/src/surfaces.ts:103

Overrides on top of the team painting, keyed by sporty colour key.

Inherited from​

SurfaceSceneOptions.colorUpdates

displayRange?​

optional displayRange?: AnyRange

Defined in: packages/sdvplot/src/surfaces.ts:106

A sporty display range for the league's sport; one the sport does not know throws sporty's UnknownDisplayRangeError.

Inherited from​

SurfaceSceneOptions.displayRange

rotation?​

optional rotation?: number

Defined in: packages/sdvplot/src/surfaces.ts:104

Inherited from​

SurfaceSceneOptions.rotation

season?​

optional season?: SeasonInput

Defined in: packages/sdvplot/src/surfaces.ts:101

Inherited from​

SurfaceSceneOptions.season

team?​

optional team?: Value

Defined in: packages/sdvplot/src/surfaces.ts:100

Inherited from​

SurfaceSceneOptions.team

units?​

optional units?: "m" | "ft" | "yd" | "in" | "cm" | "mm"

Defined in: packages/sdvplot/src/surfaces.ts:109

Inherited from​

SurfaceSceneOptions.units

updates?​

optional updates?: BasketballParamUpdates & FootballParamUpdates & HockeyParamUpdates

Defined in: packages/sdvplot/src/surfaces.ts:111

Sporty parameter overrides (intersected across sports so each sport's own keys type-check).

Inherited from​

SurfaceSceneOptions.updates

xlim?​

optional xlim?: readonly [number, number]

Defined in: packages/sdvplot/src/surfaces.ts:107

Inherited from​

SurfaceSceneOptions.xlim

xTrans?​

optional xTrans?: number

Defined in: packages/sdvplot/src/surfaces.ts:113

Inherited from​

SurfaceSceneOptions.xTrans

ylim?​

optional ylim?: readonly [number, number]

Defined in: packages/sdvplot/src/surfaces.ts:108

Inherited from​

SurfaceSceneOptions.ylim

yTrans?​

optional yTrans?: number

Defined in: packages/sdvplot/src/surfaces.ts:114

Inherited from​

SurfaceSceneOptions.yTrans