Skip to main content

Interface: PlotlyMarkOptions

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

withLogos / withWordmarks 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:32

Opacity in [0, 1]. Default 1.

Inherited from​

MarkOptions.alpha

embed?​

optional embed?: ReadonlyMap<string, string>

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

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

Inherited from​

MarkOptions.embed

height?​

optional height?: number

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

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

Inherited from​

MarkOptions.height

idSystem?​

optional idSystem?: IdSystem

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

How the team values are read. Default "auto".

Inherited from​

MarkOptions.idSystem

layer?​

optional layer?: "above" | "below"

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

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:26

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

Inherited from​

MarkOptions.league

season?​

optional season?: SeasonInput

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

A season (number or string) for every row, or the name of a row column holding each row's season.

Inherited from​

MarkOptions.season

team​

team: string

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

Name of the row column holding the team (abbreviation, name or id; see idSystem).

Inherited from​

MarkOptions.team

variant?​

optional variant?: Variant

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

Logo variant, e.g. "dark". Default "default".

Inherited from​

MarkOptions.variant

x​

x: string

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

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

Inherited from​

MarkOptions.x

xref?​

optional xref?: string

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

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:22

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

Inherited from​

MarkOptions.y

yref?​

optional yref?: string

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

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