TldrawImageProps

See source code
Table of contents

Extends TLImageExportOptions.

interface TldrawImageProps extends TLImageExportOptions {}

Properties

assetUrls

optional

Asset URL overrides.


background

optional
background?: boolean

bindingUtils

optional

Additional binding utils to use.

bindingUtils?: readonly TLAnyBindingUtilConstructor[]

bounds

optional
bounds?: Box

darkMode

optional
darkMode?: boolean

format

optional

The image format to use. Defaults to 'svg'.

format?: 'png' | 'svg'

licenseKey

optional

The license key.

licenseKey?: string

padding

optional
padding?: number

pageId

optional

The page to display. Defaults to the first page.

pageId?: TLPageId

preserveAspectRatio

optional
preserveAspectRatio?: React.SVGAttributes<SVGSVGElement>['preserveAspectRatio']

scale

optional
scale?: number

shapeUtils

optional

Additional shape utils to use.

shapeUtils?: readonly TLAnyShapeUtilConstructor[]

snapshot

The snapshot to display.

snapshot: Partial<TLEditorSnapshot> | TLStoreSnapshot

Prev
TldrawFile
Next
TldrawUiProps