Interface: SocialCardOptions

Defined in: packages/sdvplot/src/export/index.ts:45

Options for socialCard; defaults are Python/R gt_social_crop's.

Properties

aspect?

optional aspect?: Aspect

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

the canvas ratio; default "1:1"

---

background?

optional background?: string

Defined in: packages/sdvplot/src/export/index.ts:51

the canvas color; default "white"

---

color?

optional color?: string

Defined in: packages/sdvplot/src/export/index.ts:58

the canvas root color, which the figure's currentColor (Plot's axes and text) inherits; absent: black or white, whichever contrasts more with a hex background (none for a named background: give color, or a hex)

---

gravity?

optional gravity?: Gravity

Defined in: packages/sdvplot/src/export/index.ts:53

where the padded figure sits on the canvas; default "center"

---

padding?

optional padding?: number

Defined in: packages/sdvplot/src/export/index.ts:49

pixels left around the figure before the canvas grows to the ratio (truncated to an integer); default 60