TldrawImageProps

See source code
Table of contents

Extends TLImageExportOptions.

interface TldrawImageProps extends TLImageExportOptions {}

Properties

assetUrls

optional

Asset URL overrides.


background

optional

Should the background color be included in the export? If false, the generated image will be transparent (if exporting to a format that supports transparency).

background?: boolean

bindingUtils

optional

Additional binding utils to use.

bindingUtils?: readonly TLAnyBindingUtilConstructor[]

bounds

optional

The bounding box, in page coordinates, of the area being exported.

bounds?: Box

darkMode

optional

Should the export be rendered in dark mode (true) or light mode (false)? Defaults to the current instance's dark mode setting.

darkMode?: boolean

format

optional

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

format?: 'png' | 'svg'

licenseKey

optional

The license key.

licenseKey?: string

padding

optional

How much padding to include around the bounds of exports? Defaults to 32px.

padding?: number

pageId

optional

The page to display. Defaults to the first page.

pageId?: TLPageId

pixelRatio

optional

When exporting an SVG, the expected pixel ratio of the export will be passed in to TLAssetStore.resolve as the dpr property, so that assets can be downscaled to the appropriate resolution.

When exporting to a bitmap image format, the size of the resulting image will be multiplied by this number.

For SVG exports, this defaults to undefined - which means we'll request original-quality assets. For bitmap exports, this defaults to 2.

pixelRatio?: number

preserveAspectRatio

optional

The preserveAspectRatio attribute of the SVG element.

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

quality

optional

If the export is being converted to a lossy bitmap format (e.g. jpeg), this is the quality of the export. This is a number between 0 and 1.

quality?: number

scale

optional

The logical scale of the export. This scales the resulting size of the SVG being generated.

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
hi

We use cookies on this website.
Learn more in our Cookie Policy.