Canvas API Reference
kittl.design.canvas — previews and exports.
Scope: design:state:read
getPreviewImage(id, options?)
Returns a preview image URL for a given board.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Board ID to preview |
options.format | 'png' | 'jpg' | No | Image format |
options.quality | number | No | Quality (0–1) for jpg |
Returns: SdkResultAsync<string | null> — a data URL, hosted asset URL, or null when unavailable.
getScreenshot()
Captures a screenshot of the current canvas viewport.
Returns: SdkResultAsync<{ data: string; width: number; height: number }>
getExport(options)
Exports one or more boards or objects to a file.
| Property | Type | Required | Description |
|---|---|---|---|
format | 'png' | 'jpg' | 'pdf' | 'svg' | 'mp4' | Yes | Output format |
target | { boardId: string } | { nodeIds: string[] } | Yes | Content to export |
dimensions | { multiplier: number } | { pixelCount: number } | { target: { width, height } } | No | Sizing hints (aspect ratio is preserved) |
Returns: SdkResultAsync<Blob | null>