Skip to content
This is the alpha v4 version website. Looking for the v3 documentation?

ToImageOptions

ToImageOptions = object

Defined in: packages/export-image/src/options.ts:7

Properties

backgroundColor

backgroundColor: string

Defined in: packages/export-image/src/options.ts:18


cameraState

cameraState: null | CameraState

Defined in: packages/export-image/src/options.ts:17


fileName

fileName: string

Defined in: packages/export-image/src/options.ts:10


format

format: "png" | "jpeg"

Defined in: packages/export-image/src/options.ts:11


height

height: null | number

Defined in: packages/export-image/src/options.ts:9


sigmaOverrides

sigmaOverrides: Partial<{ primitives: Override<PrimitivesDeclaration>; settings: Override<Settings, Partial<Settings>>; styles: Override<StylesDeclaration>; }>

Defined in: packages/export-image/src/options.ts:12


width

width: null | number

Defined in: packages/export-image/src/options.ts:8


withTempRenderer

withTempRenderer: null | ((tmpRenderer) => void) | ((tmpRenderer) => Promise<void>)

Defined in: packages/export-image/src/options.ts:19