Skip to main content

Interface: D3HeadshotOptions

Defined in: packages/sdvplot/src/d3/index.ts:37

Face options for appendHeadshots (blazing-the-nets main scatter "faces", lib/charts/scatterChart.ts:139-191).

Extends​

Properties​

alpha?​

optional alpha?: number

Defined in: packages/sdvplot/src/d3/index.ts:24

Inherited from​

Frame.alpha

ariaLabel?​

optional ariaLabel?: (value, i) => string

Defined in: packages/sdvplot/src/d3/index.ts:29

Each image's accessible name from its input value and index; default the team ("KC logo", whatever id system the values use) or the player id ("3139477 headshot").

Parameters​

value​

Value

i​

number

Returns​

string

Inherited from​

Frame.ariaLabel

clip?​

optional clip?: "circle"

Defined in: packages/sdvplot/src/d3/faces.ts:10

"circle": the headshot inside a circle whose diameter is height × frameHeight. The image is drawn 2.3 R tall so the head fills the circle, so drawnMarks reports 1.15 × height for a face.

Inherited from​

FaceOptions.clip

frameHeight​

frameHeight: number

Defined in: packages/sdvplot/src/d3/index.ts:22

Inherited from​

Frame.frameHeight

height?​

optional height?: number

Defined in: packages/sdvplot/src/d3/index.ts:23

Inherited from​

Frame.height

idSystem?​

optional idSystem?: HeadshotIdSystem

Defined in: packages/sdvplot/src/d3/index.ts:40

"espn" (default) or "gsis". "gsis" needs loadGsis() to have run first, else this throws InputError.

league​

league: "cfb" | "mbb" | "mlb" | "nba" | "nfl" | "nhl" | "wbb" | "wnba"

Defined in: packages/sdvplot/src/d3/index.ts:38

placeholder?​

optional placeholder?: string | ((id) => string)

Defined in: packages/sdvplot/src/d3/faces.ts:14

A disc behind the face at 0.35 opacity, still there if the image fails (:169-172). Default none.

Inherited from​

FaceOptions.placeholder

ring?​

optional ring?: string | ((id) => string)

Defined in: packages/sdvplot/src/d3/faces.ts:12

Ring colour per player id (e.g. the team colour; :183-188, 1.5 px). Default none.

Inherited from​

FaceOptions.ring

x​

x: (v) => number

Defined in: packages/sdvplot/src/d3/index.ts:20

Parameters​

v​

Value

Returns​

number

Inherited from​

Frame.x

y​

y: (v) => number

Defined in: packages/sdvplot/src/d3/index.ts:21

Parameters​

v​

Value

Returns​

number

Inherited from​

Frame.y