Skip to main content

Interface: PlotlyHeadshotOptions

Defined in: packages/sdvplot/src/plotly.ts:98

withHeadshots options: the shared ones plus the subplot axes and the image layer.

Extends​

Properties​

alpha?​

optional alpha?: number

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

Opacity in [0, 1]. Default 1.

Inherited from​

HeadshotOptions.alpha

embed?​

optional embed?: ReadonlyMap<string, string>

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

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

Inherited from​

HeadshotOptions.embed

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.

Inherited from​

HeadshotOptions.height

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".

Inherited from​

HeadshotOptions.idSystem

layer?​

optional layer?: "above" | "below"

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

Draw the images above (default) or below the traces.

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".

Inherited from​

HeadshotOptions.league

player​

player: string

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

Name of the row column holding the player id.

Inherited from​

HeadshotOptions.player

x​

x: string

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

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

Inherited from​

HeadshotOptions.x

xref?​

optional xref?: string

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

The x axis the images are placed on, e.g. "x2" for a subplot. Default "x".

y​

y: string

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

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

Inherited from​

HeadshotOptions.y

yref?​

optional yref?: string

Defined in: packages/sdvplot/src/plotly.ts:102

The y axis the images are placed on, e.g. "y2" for a subplot. Default "y".