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

drawOnCanvas

drawOnCanvas(sigma, opts?): Promise<HTMLCanvasElement>

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

This function takes a Sigma instance and some options, and returns a HTMLCanvasElement, with the sigma stage canvas drawn on it. This new canvas can then be used to generate PNG or JPEG images, for instance.

Parameters

sigma

Sigma

opts?

Partial<Omit<ToImageOptions, "fileName" | "format">> = {}

Returns

Promise<HTMLCanvasElement>