PicEditInstall

Summary

Create a new canvas image with specified dimensions and options.

Inputs

• outputFormat (required) — Output image format (PNG, JPEG, or WEBP).
• quality — Image quality (1-100), applicable when output format is JPEG or WEBP.
• fieldName — Name of the field in the binary output.
• canvasType (required) — Type of canvas to create (blank or from an image).
• width — Width of the canvas in pixels, applicable for a blank canvas.
• height — Height of the canvas in pixels, applicable for a blank canvas.
• backgroundColor — Background color of the canvas, applicable for a blank canvas.
• imagePath — Path to the background image file, applicable for creating a canvas from an image.

Output shape

a binary file representing the created canvas image

Returns the created canvas image in the specified output format along with any associated metadata.

Examples

Example 1: Create a blank canvas

Specify width, height, and background color to generate a blank canvas in PNG format.

Example 2: Create a canvas from an image

Provide the image path to create a canvas with the dimensions of the image.