Skip to main content

Interface: ContractAdapter<T>

Defined in: packages/sdvplot/src/testing/index.ts:46

Adapters must accept typed arrays (e.g. Float64Array) for the x and y positions: rule 3 passes them.

Type Parameters​

T​

T

Properties​

name​

name: string

Defined in: packages/sdvplot/src/testing/index.ts:47

supportsAxisLogos​

supportsAxisLogos: boolean

Defined in: packages/sdvplot/src/testing/index.ts:72

Methods​

addHeadshots()​

addHeadshots(target, x, y, players, o): T | Promise<T>

Defined in: packages/sdvplot/src/testing/index.ts:63

league is narrowed to the ESPN-headshot leagues: the contract checks that before calling, so adapters need no cast.

Parameters​

target​

T

x​

ArrayLike<Value>

y​

ArrayLike<Value>

players​

readonly Value[]

o​

Omit<ContractMarkOptions, "league"> & object

Returns​

T | Promise<T>

addLogos()​

addLogos(target, x, y, teams, o): T | Promise<T>

Defined in: packages/sdvplot/src/testing/index.ts:48

Parameters​

target​

T

x​

ArrayLike<Value>

y​

ArrayLike<Value>

teams​

readonly Value[]

o​

ContractMarkOptions

Returns​

T | Promise<T>

addWordmarks()​

addWordmarks(target, x, y, teams, o): T | Promise<T>

Defined in: packages/sdvplot/src/testing/index.ts:55

Parameters​

target​

T

x​

ArrayLike<Value>

y​

ArrayLike<Value>

teams​

readonly Value[]

o​

ContractMarkOptions

Returns​

T | Promise<T>

axisLogos()​

axisLogos(target, axis, o): T | Promise<T>

Defined in: packages/sdvplot/src/testing/index.ts:71

Throws UnsupportedTargetError when supportsAxisLogos is false.

Parameters​

target​

T

axis​

"x" | "y"

o​
height?​

number

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"

Returns​

T | Promise<T>

drawnAxisMarks()​

drawnAxisMarks(target, axis): readonly object[]

Defined in: packages/sdvplot/src/testing/index.ts:74

Parameters​

target​

T

axis​

"x" | "y"

Returns​

readonly object[]

drawnMarks()​

drawnMarks(target): readonly DrawnMark[]

Defined in: packages/sdvplot/src/testing/index.ts:73

Parameters​

target​

T

Returns​

readonly DrawnMark[]

visibleAxisLabels()​

visibleAxisLabels(target, axis): readonly string[]

Defined in: packages/sdvplot/src/testing/index.ts:75

Parameters​

target​

T

axis​

"x" | "y"

Returns​

readonly string[]