toCanvaImageBlob

API reference for the "toCanvaImageBlob" method.

Converts any of the following inputs into a CanvaImageBlob:
​CanvaElement​
​CanvaMedia​
​CanvaImageUrl​
​HTMLCanvasElement​
​HTMLImageElement​
​SVGElement​
This method supersedes the fromCanvas and fromElement methods.
Usage
const { imageHelpers } = window.canva;
const canva = window.canva.init();
​
canva.onReady(async (opts) => {
  const image = await imageHelpers.toCanvaImageBlob(opts.element, {
    quality: "preview",
  });
  console.log(image);
});
Parameters
Name
Type
Required
Description
image
CanvaElement | CanvaMedia | CanvaImageUrl | HTMLCanvasElement | HTMLImageElement | SVGElement
Yes
The input to convert into a CanvaImageBlob.
opts
object
No
Options for configuring the CanvaImageBlob.
opts.quality
ImageQuality
No
The quality of the CanvaImageBlob. This parameter is only used when the input is aCanvaElement or CanvaMedia.
opts.type
string
No
The MIME type of the CanvaImageBlob. The supported values include "image/jpeg", "image/png", and "image/svg+xml". This parameter is only used when the input is a HTMLCanvasElement or HTMLImageElement.
Returns
Promise<CanvaImageBlob>
Types
ImageQuality
Signature
const enum ImageQuality = {
  FULL = "full",
  PREVIEW = "preview",
  THUMBNAIL = "thumbnail"
}
Properties
Name
Value
FULL
"full"
PREVIEW
"preview"
THUMBNAIL
"thumbnail"

Name	Type	Required	Description
`image`	`CanvaElement` \| `CanvaMedia` \| `CanvaImageUrl` \| `HTMLCanvasElement` \| `HTMLImageElement` \| `SVGElement`	Yes	The input to convert into a `CanvaImageBlob`.
`opts`	object	No	Options for configuring the `CanvaImageBlob`.
`opts.quality`	`ImageQuality`	No	The quality of the `CanvaImageBlob`. This parameter is only used when the `input` is a`CanvaElement` or `CanvaMedia`.
`opts.type`	string	No	The MIME type of the `CanvaImageBlob`. The supported values include `"image/jpeg"`, `"image/png"`, and `"image/svg+xml"`. This parameter is only used when the `input` is a `HTMLCanvasElement` or `HTMLImageElement`.

Name	Value
FULL	`"full"`
PREVIEW	`"preview"`
THUMBNAIL	`"thumbnail"`

getSize

toCanvas

Last modified 1yr ago