Skip to main content

Interface: HeadshotOptions

Defined in: packages/sdvplot/src/_web.ts:41

Options of withHeadshots.

Extended by​

Properties​

alpha?​

optional alpha?: number

Defined in: packages/sdvplot/src/_web.ts:53

Opacity in [0, 1]. Default 1.

embed?​

optional embed?: ReadonlyMap<string, string>

Defined in: packages/sdvplot/src/_web.ts:57

url → data URI map from embedSources, to inline the images.

height?​

optional height?: number

Defined in: packages/sdvplot/src/_web.ts:51

Headshot height as a fraction of the plot area's height, in (0, 1]. Default 0.1.

idSystem?​

optional idSystem?: "espn" | "gsis"

Defined in: packages/sdvplot/src/_web.ts:55

What the player ids are: ESPN athlete ids, or nflverse gsis ids (needs loadGsis() first). Default "espn".

league​

league: "aaf" | "ahl" | "cfb" | "cricket" | "echl" | "mbb" | "milb" | "mlb" | "nba" | "nbagl" | "ncaa_baseball" | "ncaa_mhockey" | "ncaa_softball" | "ncaa_whockey" | "nfl" | "nhl" | "ohl" | "phf" | "pwhl" | "qmjhl" | "soccer" | "ufl" | "usfl" | "ushl" | "wbb" | "whl" | "wnba" | "xfl"

Defined in: packages/sdvplot/src/_web.ts:49

The league the teams (or players) belong to, e.g. "nfl".

player​

player: string

Defined in: packages/sdvplot/src/_web.ts:47

Name of the row column holding the player id.

x​

x: string

Defined in: packages/sdvplot/src/_web.ts:43

Name of the row column holding each headshot's x position.

y​

y: string

Defined in: packages/sdvplot/src/_web.ts:45

Name of the row column holding each headshot's y position.