surface

surface(
    league: str,
    team: Any = None,
    *,
    season: Any = None,
    ax: Any = None,
    center_logo: bool | float = False,
    **sportypy_kwargs: Any,
) -> Any

Draw the league's playing surface with sportypy, in a team's colors.

Arguments

Name	Type	Description
league	str	The SDV league key, e.g. "nfl", "nba", "nhl", "cfb", "soccer".
team	Any	A team to color the surface by (end zones, lane and apron, center line and boards); None for the plain surface.
season	Any	The season, for teams whose colors changed.
ax	Any	The matplotlib Axes to draw on; None makes a new figure.
center_logo	bool | float	True to draw the team's logo at center ice / court / field (0.25 of the Axes height), or a height fraction.
**sportypy_kwargs	Any	Passed to sportypy: display_range, xlim, ylim and rotation go to draw(); the rest (field_updates, color_updates, units, ...) to the surface class.

Returns

matplotlib.axes.Axes — The Axes sportypy drew on.

Raises

• ValueError: If sportypy has no surface for league.
• OptionalDependencyError: If the surfaces extra (sportypy) is not installed.

Example

import sdvplot

ax = sdvplot.surface("nfl", "KC", center_logo=True)

See also

• sdvplotR sdv_surface()
• sportypy