Skip to main content
Version: 0.1.1

sdvplot.holoviews

The HoloViews adapter: a Bokeh plot hook that draws the marks through the Bokeh adapter when the element renders.

NameWhat it is
add_headshotsDraw each player's headshot centred on its (x, y) point of a HoloViews element (Bokeh backend).
add_logosDraw each team's logo centred on its (x, y) point of a HoloViews element (Bokeh backend).
add_wordmarksDraw each team's wordmark centred on its (x, y) point of a HoloViews element (Bokeh backend).
axis_logosNot supported on HoloViews (it draws through Bokeh, which has no axis logos yet).

add_headshots​

add_headshots(
element: Any,
x: Any,
y: Any,
players: Any,
*,
league: str,
height: float = 0.1,
alpha: float = 1,
embed: bool = False,
id_system: str = 'espn',
) -> Any

Draw each player's headshot centred on its (x, y) point of a HoloViews element (Bokeh backend).

Arguments​

NameTypeDescription
elementAnyA HoloViews element or overlay.
xAnyThe points' x positions, in the element's x values.
yAnyThe points' y positions, the same length as x.
playersAnyThe player id for each point.
leaguestrThe SDV league key, e.g. "nfl".
heightfloatThe headshot height as a fraction of the plot's reference height, in (0, 1].
alphafloatOpacity, 0 to 1.
embedboolInline each image as a data URI instead of linking its URL.
id_systemstr"espn" (ESPN athlete ids), "gsis" (NFL) or "league" (the league's own player id: nfl gsis, NBA and WNBA Stats ids, MLBAM, NHL), as in headshot_url.

Returns​

object — A copy of element with the drawing hook added.

Raises​

  • InputError: (a ValueError) If height or alpha is out of range, league has no ESPN headshots, or id_system is not valid for league.
  • ValueError: If the inputs differ in length; when the plot renders, if its figure has no pixel height (no frame_height or height option).
  • TypeError: If the current HoloViews backend is not Bokeh.
  • UnsupportedTargetError: (a TypeError) If element is not a HoloViews element or overlay.
  • OfflineError: If the nflverse player table (id_system="gsis"), or with embed=True a headshot, is neither cached nor downloadable (a DownloadError, also an OSError, for an HTTP error status).
  • UnsafeDownloadError: (an OSError) If a download is refused: larger than the byte cap, past the deadline, or redirected away from https.

Example​

import holoviews as hv
import sdvplot

hv.extension("bokeh")
sdvplot.add_headshots(hv.Scatter([(0.5, 0.5)]), [0.5], [0.5], ["3139477"], league="nfl", height=0.2)

See also​

add_logos​

add_logos(
element: Any,
x: Any,
y: Any,
teams: Any,
*,
league: str,
season: Any = None,
height: float = 0.1,
alpha: float = 1,
variant: str = 'default',
embed: bool = False,
id_system: str = 'auto',
) -> Any

Draw each team's logo centred on its (x, y) point of a HoloViews element (Bokeh backend).

Returns a copy of the element with a Bokeh plot hook; the logos appear when it renders (hv.render, a notebook, hv.save). Sizing is the Bokeh adapter's: a fraction of the plot's frame_height when set, else its height; a responsive plot has neither, so give it a frame_height (without one, HoloViews logs the hook's ValueError and draws no marks).

Arguments​

NameTypeDescription
elementAnyA HoloViews element or overlay (hv.Scatter, hv.Points * hv.Curve, ...).
xAnyThe points' x positions, in the element's x values.
yAnyThe points' y positions, the same length as x.
teamsAnyThe team for each point, in any id system resolve() understands.
leaguestrThe SDV league key, e.g. "nfl".
seasonAnyOne season, or one per point, to pick each team's mark for that era.
heightfloatThe logo height as a fraction of the plot's reference height, in (0, 1].
alphafloatOpacity, 0 to 1.
variantstr"default", "dark", or a named variant from marks().
embedboolInline each image as a data URI instead of linking its URL.
id_systemstrThe id system of teams; "auto" tries each in order.

Returns​

object — A copy of element with the drawing hook added to its existing hooks.

Raises​

  • InputError: (a ValueError) If height or alpha is out of range, league, id_system or variant is unknown, or season is not a year or is outside the seasons sdvplot knows for the league.
  • ValueError: If the inputs differ in length; when the plot renders, if its figure has no pixel height (no frame_height or height option).
  • TypeError: If the current HoloViews backend is not Bokeh.
  • UnsupportedTargetError: (a TypeError) If element is not a HoloViews element or overlay.
  • OfflineError: If the logo manifest, or with embed=True a mark's image, is neither cached nor downloadable (a DownloadError, also an OSError, when the CDN answers with an error status; an IntegrityError when it sends a file that does not match the manifest's sha256).
  • UnsafeDownloadError: (an OSError) If a download is refused: larger than the byte cap, past the deadline, or redirected away from https.
  • UnsafeCachePathError: (a ValueError) If embed=True and the manifest's sha256 or extension for a mark would put the file outside the cache directory.

Example​

import holoviews as hv
import sdvplot

hv.extension("bokeh")
points = hv.Scatter([(10, -3), (20, -7)]).opts(frame_height=300)
points = sdvplot.add_logos(points, [10, 20], [-3, -7], ["KC", "BUF"], league="nfl", height=0.15)

See also​

add_wordmarks​

add_wordmarks(
element: Any,
x: Any,
y: Any,
teams: Any,
*,
league: str,
season: Any = None,
height: float = 0.1,
alpha: float = 1,
variant: str = 'default',
embed: bool = False,
id_system: str = 'auto',
) -> Any

Draw each team's wordmark centred on its (x, y) point of a HoloViews element (Bokeh backend).

Arguments​

NameTypeDescription
elementAnyA HoloViews element or overlay.
xAnyThe points' x positions, in the element's x values.
yAnyThe points' y positions, the same length as x.
teamsAnyThe team for each point, in any id system resolve() understands.
leaguestrThe SDV league key, e.g. "nfl".
seasonAnyOne season, or one per point.
heightfloatThe wordmark height as a fraction of the plot's reference height, in (0, 1].
alphafloatOpacity, 0 to 1.
variantstr"default", "dark", or a named variant from marks().
embedboolInline each image as a data URI instead of linking its URL.
id_systemstrThe id system of teams; "auto" tries each in order.

Returns​

object — A copy of element with the drawing hook added.

Raises​

  • InputError: (a ValueError) If height or alpha is out of range, league, id_system or variant is unknown, or season is not a year or is outside the seasons sdvplot knows for the league.
  • ValueError: If the inputs differ in length; when the plot renders, if its figure has no pixel height (no frame_height or height option).
  • TypeError: If the current HoloViews backend is not Bokeh.
  • UnsupportedTargetError: (a TypeError) If element is not a HoloViews element or overlay.
  • OfflineError: If the logo manifest, or with embed=True a mark's image, is neither cached nor downloadable (a DownloadError, also an OSError, when the CDN answers with an error status; an IntegrityError when it sends a file that does not match the manifest's sha256).
  • UnsafeDownloadError: (an OSError) If a download is refused: larger than the byte cap, past the deadline, or redirected away from https.
  • UnsafeCachePathError: (a ValueError) If embed=True and the manifest's sha256 or extension for a mark would put the file outside the cache directory.

Example​

import holoviews as hv
import sdvplot

hv.extension("bokeh")
bars = hv.Bars([("KC", 12), ("BUF", 10)])
bars = sdvplot.add_wordmarks(bars, ["KC", "BUF"], [12, 10], ["KC", "BUF"], league="nfl", height=0.06)

See also​

axis_logos​

axis_logos(target: Any, axis: str, **kwargs: Any) -> Any

Not supported on HoloViews (it draws through Bokeh, which has no axis logos yet).

Arguments​

NameTypeDescription
targetAnyA HoloViews element.
axisstr"x" or "y".
**kwargsAnyIgnored.

Returns​

object — Never returns.

Raises​

  • UnsupportedTargetError: (a TypeError) Always. Draw the logos inside the plot with add_logos, or use the matplotlib, Plotly or Altair adapter for axis logos.

Example​

import holoviews as hv
import sdvplot

try:
sdvplot.axis_logos(hv.Bars([("KC", 12)]), "x", league="nfl")
except TypeError:
pass # raised: HoloViews has no axis logos yet

See also​