Skip to main content
Version: 0.0.9

Canvas Utilities

The kittl.design.canvas API offers tools for generating previews and capturing screenshots of the canvas.

Getting a Preview Image​

If you need a preview image of a specific board, you can request one via getPreviewImage. It returns a string (e.g. a data URL or hosted asset URL), or null when unavailable.

const previewResult = await kittl.design.canvas.getPreviewImage('board-id');

if (previewResult.isOk && previewResult.result) {
    console.log('Preview URL:', previewResult.result);
}

Taking a Screenshot​

You can capture exactly what the user currently sees on the canvas:

const screenshotResult = await kittl.design.canvas.getScreenshot();

if (screenshotResult.isOk) {
    const screenshot = screenshotResult.result;
    console.log(`Screenshot: ${screenshot.width}x${screenshot.height}`, screenshot.data);
}

See Canvas API Reference for full parameter details.