Skip to main content

Function: colorKeys()

Call Signature​

colorKeys(sport): readonly ["plot_background", "infield_dirt", "infield_grass", "pitchers_mound", "base", "pitchers_plate", "batters_box", "catchers_box", "foul_line", "running_lane"]

Defined in: packages/sporty/src/api.ts:353

Keys accepted by SurfaceOptions.colorUpdates.

Parameters​

sport​

"baseball"

Returns​

readonly ["plot_background", "infield_dirt", "infield_grass", "pitchers_mound", "base", "pitchers_plate", "batters_box", "catchers_box", "foul_line", "running_lane"]

Call Signature​

colorKeys(sport): readonly ["plot_background", "defensive_half_court", "offensive_half_court", "court_apron", "center_circle_outline", "center_circle_fill", "division_line", "endline", "sideline", "two_point_range", "three_point_line", "painted_area", "lane_boundary", "free_throw_circle_outline", "free_throw_circle_fill", "free_throw_circle_dash", "lane_space_mark", "inbounding_line", "substitution_line", "baseline_lower_defensive_box", "lane_lower_defensive_box", "team_bench_line", "restricted_arc", "backboard", "basket_ring", "net"]

Defined in: packages/sporty/src/api.ts:354

Keys accepted by SurfaceOptions.colorUpdates.

Parameters​

sport​

"basketball"

Returns​

readonly ["plot_background", "defensive_half_court", "offensive_half_court", "court_apron", "center_circle_outline", "center_circle_fill", "division_line", "endline", "sideline", "two_point_range", "three_point_line", "painted_area", "lane_boundary", "free_throw_circle_outline", "free_throw_circle_fill", "free_throw_circle_dash", "lane_space_mark", "inbounding_line", "substitution_line", "baseline_lower_defensive_box", "lane_lower_defensive_box", "team_bench_line", "restricted_arc", "backboard", "basket_ring", "net"]

Call Signature​

colorKeys(sport): readonly ["plot_background", "end_1", "centre_zone", "end_2", "sheet_apron", "centre_line", "tee_line", "back_line", "hog_line", "hack_line", "courtesy_line", "hack", "button", "house_rings"]

Defined in: packages/sporty/src/api.ts:355

Keys accepted by SurfaceOptions.colorUpdates.

Parameters​

sport​

"curling"

Returns​

readonly ["plot_background", "end_1", "centre_zone", "end_2", "sheet_apron", "centre_line", "tee_line", "back_line", "hog_line", "hack_line", "courtesy_line", "hack", "button", "house_rings"]

Call Signature​

colorKeys(sport): readonly ["plot_background", "field_apron", "offensive_half", "defensive_half", "offensive_endzone", "defensive_endzone", "end_line", "sideline", "field_border", "field_border_outline", "red_zone_border", "red_zone_border_outline", "major_yard_line", "goal_line", "minor_yard_line", "directional_arrow", "try_mark", "yardage_marker", "restricted_area", "coaching_box", "team_bench_area", "team_bench_area_outline", "coaching_box_line"]

Defined in: packages/sporty/src/api.ts:356

Keys accepted by SurfaceOptions.colorUpdates.

Parameters​

sport​

"football"

Returns​

readonly ["plot_background", "field_apron", "offensive_half", "defensive_half", "offensive_endzone", "defensive_endzone", "end_line", "sideline", "field_border", "field_border_outline", "red_zone_border", "red_zone_border_outline", "major_yard_line", "goal_line", "minor_yard_line", "directional_arrow", "try_mark", "yardage_marker", "restricted_area", "coaching_box", "team_bench_area", "team_bench_area_outline", "coaching_box_line"]

Call Signature​

colorKeys(sport): readonly ["plot_background", "boards", "ozone_ice", "nzone_ice", "dzone_ice", "center_line", "zone_line", "goal_line", "restricted_trapezoid", "goal_crease_outline", "goal_crease_fill", "referee_crease", "center_faceoff_spot", "faceoff_spot_ring", "faceoff_spot_stripe", "center_faceoff_circle", "odzone_faceoff_circle", "faceoff_line", "goal_frame", "goal_fill", "team_a_bench", "team_b_bench", "team_a_penalty_box", "team_b_penalty_box", "off_ice_officials_box"]

Defined in: packages/sporty/src/api.ts:357

Keys accepted by SurfaceOptions.colorUpdates.

Parameters​

sport​

"hockey"

Returns​

readonly ["plot_background", "boards", "ozone_ice", "nzone_ice", "dzone_ice", "center_line", "zone_line", "goal_line", "restricted_trapezoid", "goal_crease_outline", "goal_crease_fill", "referee_crease", "center_faceoff_spot", "faceoff_spot_ring", "faceoff_spot_stripe", "center_faceoff_circle", "odzone_faceoff_circle", "faceoff_line", "goal_frame", "goal_fill", "team_a_bench", "team_b_bench", "team_a_penalty_box", "team_b_penalty_box", "off_ice_officials_box"]

Call Signature​

colorKeys(sport): readonly ["plot_background", "field_apron", "defensive_zone", "neutral_zone", "offensive_zone", "team_a_bench", "team_b_bench", "team_a_penalty_box", "team_b_penalty_box", "off_field_officials_box", "boards", "end_line", "sideline", "center_line", "wing_line", "restraining_line", "defensive_area_line", "goal_line", "referee_crease", "referee_crease_fill", "goal_circle", "goal_circle_fill", "goal_arc", "goal_fan", "goal_fan_hash_mark", "goal_mouth_hash_mark", "goal_mouth", "below_goal_marking", "goal_frame", "goal_net", "center_circle", "center_face_off_marker", "corner_face_off_marker", "change_area_outline", "change_area_fill"]

Defined in: packages/sporty/src/api.ts:358

Keys accepted by SurfaceOptions.colorUpdates.

Parameters​

sport​

"lacrosse"

Returns​

readonly ["plot_background", "field_apron", "defensive_zone", "neutral_zone", "offensive_zone", "team_a_bench", "team_b_bench", "team_a_penalty_box", "team_b_penalty_box", "off_field_officials_box", "boards", "end_line", "sideline", "center_line", "wing_line", "restraining_line", "defensive_area_line", "goal_line", "referee_crease", "referee_crease_fill", "goal_circle", "goal_circle_fill", "goal_arc", "goal_fan", "goal_fan_hash_mark", "goal_mouth_hash_mark", "goal_mouth", "below_goal_marking", "goal_frame", "goal_net", "center_circle", "center_face_off_marker", "corner_face_off_marker", "change_area_outline", "change_area_fill"]

Call Signature​

colorKeys(sport): readonly ["plot_background", "offensive_half_pitch", "defensive_half_pitch", "pitch_apron", "touchline", "goal_line", "corner_arc", "halfway_line", "center_circle", "center_mark", "penalty_box", "goal_box", "penalty_mark", "corner_defensive_mark", "goal"]

Defined in: packages/sporty/src/api.ts:359

Keys accepted by SurfaceOptions.colorUpdates.

Parameters​

sport​

"soccer"

Returns​

readonly ["plot_background", "offensive_half_pitch", "defensive_half_pitch", "pitch_apron", "touchline", "goal_line", "corner_arc", "halfway_line", "center_circle", "center_mark", "penalty_box", "goal_box", "penalty_mark", "corner_defensive_mark", "goal"]

Call Signature​

colorKeys(sport): readonly ["plot_background", "baseline", "singles_sideline", "doubles_sideline", "serviceline", "center_serviceline", "center_mark", "ad_court", "deuce_court", "backcourt", "doubles_alley", "court_apron", "net"]

Defined in: packages/sporty/src/api.ts:360

Keys accepted by SurfaceOptions.colorUpdates.

Parameters​

sport​

"tennis"

Returns​

readonly ["plot_background", "baseline", "singles_sideline", "doubles_sideline", "serviceline", "center_serviceline", "center_mark", "ad_court", "deuce_court", "backcourt", "doubles_alley", "court_apron", "net"]

Call Signature​

colorKeys(sport): readonly ["plot_background", "free_zone", "front_zone", "defensive_backcourt", "offensive_backcourt", "court_apron", "end_line", "sideline", "attack_line", "center_line", "service_zone_mark", "substitution_zone"]

Defined in: packages/sporty/src/api.ts:361

Keys accepted by SurfaceOptions.colorUpdates.

Parameters​

sport​

"volleyball"

Returns​

readonly ["plot_background", "free_zone", "front_zone", "defensive_backcourt", "offensive_backcourt", "court_apron", "end_line", "sideline", "attack_line", "center_line", "service_zone_mark", "substitution_zone"]

Call Signature​

colorKeys(sport): readonly string[]

Defined in: packages/sporty/src/api.ts:362

Keys accepted by SurfaceOptions.colorUpdates.

Parameters​

sport​

Sport

Returns​

readonly string[]