ApexPainter member
ApexPainter.createImage
Draw one or more image/shape layers onto an existing canvas buffer.
apexify.jsCURRENTnode22node24node26
Source: lib-next/apex-painter/main.ts (opens in a new tab)Signature
(images: ImageProperties | ImageProperties[], canvasBuffer: CanvasResults | Buffer, options?: CreateImageOptions, painterOpts?: PainterAssetRefsOptions) => Promise<Buffer>Parameters
images
ImageProperties | ImageProperties[]
canvasBuffer
Buffer<ArrayBufferLike> | CanvasResults
options?
painterOpts?
Options
512 / 512 option paths
| Option | Type | Contract | Allowed values | Runtime & capabilities |
|---|---|---|---|---|
| images | ||||
images.alignAlignment used when fitted source dimensions do not exactly match the destination box. | AlignMode | OptionalDefault"center" | 9 values"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" | node22 · node24 · node26 |
images.blendModeCanvas composite operation used for the layer. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
images.blurLayer blur amount. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.borderPositionBorder/corner positioning hint used by rounded rendering helpers. | string | OptionalDefault— | — | node22 · node24 · node26 |
images.borderRadiusLayer clipping radius or circular clipping mode. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
images.boxBackgroundOptional background fill behind the layer box. | BoxBackground | OptionalDefault— | — | node22 · node24 · node26 |
images.boxBackground.colorPublished images.boxBackground.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
images.boxBackground.gradientPublished images.boxBackground.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
images.boxBackground.gradient.colorsPublished images.boxBackground.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.boxBackground.gradient.colors.colorPublished images.boxBackground.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.boxBackground.gradient.colors.stopPublished images.boxBackground.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.boxBackground.gradient.endXPublished images.boxBackground.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.boxBackground.gradient.endYPublished images.boxBackground.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.boxBackground.gradient.pivotXPublished images.boxBackground.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.boxBackground.gradient.pivotYPublished images.boxBackground.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.boxBackground.gradient.repeatPublished images.boxBackground.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
images.boxBackground.gradient.rotatePublished images.boxBackground.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.boxBackground.gradient.startXPublished images.boxBackground.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.boxBackground.gradient.startYPublished images.boxBackground.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.boxBackground.gradient.typePublished images.boxBackground.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
images.boxBackground.gradient.endRadiusPublished images.boxBackground.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.boxBackground.gradient.startRadiusPublished images.boxBackground.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.boxBackground.gradient.centerXPublished images.boxBackground.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.boxBackground.gradient.centerYPublished images.boxBackground.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.boxBackground.gradient.startAnglePublished images.boxBackground.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.clipPathPolygon points used to clip the layer. | { x: number; y: number; }[] | OptionalDefault— | — | node22 · node24 · node26 |
images.clipPath.xPublished images.clipPath.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.clipPath.yPublished images.clipPath.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.distortionOptional perspective/warp/bulge/pinch distortion configuration. | { type: "perspective" | "warp" | "bulge" | "pinch"; points?: { x: number; y: number; }[]; intensity?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
images.distortion.intensityDistortion strength where supported. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.distortion.pointsControl points used by distortion modes that require them. | { x: number; y: number; }[] | OptionalDefault— | — | node22 · node24 · node26 |
images.distortion.points.xPublished images.distortion.points.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.distortion.points.yPublished images.distortion.points.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.distortion.typeDistortion algorithm. | "perspective" | "warp" | "bulge" | "pinch" | RequiredDefaultRequired | "perspective" "warp" "bulge" "pinch" | node22 · node24 · node26 |
images.effectsOptional post-processing visual effects. | { vignette?: { intensity: number; size: number; }; lensFlare?: { x: number; y: number; intensity: number; }; chromaticAberration?: { intensity: number; }; filmGrain?: { intensity: number; }; } | OptionalDefault— | — | node22 · node24 · node26 |
images.effects.chromaticAberrationChromatic-aberration effect settings. | { intensity: number; } | OptionalDefault— | — | node22 · node24 · node26 |
images.effects.chromaticAberration.intensityChromatic-aberration intensity. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.effects.filmGrainFilm-grain effect settings. | { intensity: number; } | OptionalDefault— | — | node22 · node24 · node26 |
images.effects.filmGrain.intensityFilm-grain intensity. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.effects.lensFlareLens-flare effect settings. | { x: number; y: number; intensity: number; } | OptionalDefault— | — | node22 · node24 · node26 |
images.effects.lensFlare.intensityLens-flare intensity. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.effects.lensFlare.xLens-flare x coordinate. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.effects.lensFlare.yLens-flare y coordinate. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.effects.vignetteVignette effect settings. | { intensity: number; size: number; } | OptionalDefault— | — | node22 · node24 · node26 |
images.effects.vignette.intensityVignette intensity. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.effects.vignette.sizeVignette size. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.filterIntensityShared filter intensity value where supported by the selected filter. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.filterOrderWhether filters are applied before or after other image processing stages. | "pre" | "post" | OptionalDefault— | "pre" "post" | node22 · node24 · node26 |
images.filtersOrdered image-filter operations applied to the layer. | ImageFilter[] | OptionalDefault— | — | node22 · node24 · node26 |
images.filters.anglePublished images.filters.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.filters.centerXPublished images.filters.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.filters.centerYPublished images.filters.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.filters.heightPublished images.filters.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.filters.intensityPublished images.filters.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.filters.levelsPublished images.filters.levels option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.filters.radiusPublished images.filters.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.filters.sizePublished images.filters.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.filters.typePublished images.filters.type option. | "saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize" | RequiredDefaultRequired | 17 values"saturation" "gaussianBlur" "motionBlur" "radialBlur" "sharpen" "noise" "grain" "edgeDetection" "emboss" "invert" "grayscale" "sepia" "pixelate" "brightness" "contrast" "hueShift" "posterize" | node22 · node24 · node26 |
images.filters.valuePublished images.filters.value option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.filters.widthPublished images.filters.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.filters.xOptional pixelate region. Omit for the whole filtered surface. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.filters.yPublished images.filters.y option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.fitHow source content fits the destination box. | FitMode | OptionalDefault"fill" | "fill" "contain" "cover" | node22 · node24 · node26 |
images.heightOptional destination height; validated against runtime canvas limits. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.inheritPreserve source sizing behavior when supported by image composition. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
images.maskOptional alpha/luminance mask configuration. | { source: string | Buffer<ArrayBufferLike>; mode?: "alpha" | "luminance" | "inverse"; } | OptionalDefault— | — | node22 · node24 · node26 |
images.mask.modeMask interpretation mode. | "alpha" | "luminance" | "inverse" | OptionalDefault"alpha" | "alpha" "luminance" "inverse" | node22 · node24 · node26 |
images.mask.sourceImage source used as the mask. | string | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.meshWarpMesh-warp grid and control-point configuration. | { gridX?: number; gridY?: number; controlPoints?: { x: number; y: number; }[][]; } | OptionalDefault— | — | node22 · node24 · node26 |
images.meshWarp.controlPointsNested mesh control-point grid. | { x: number; y: number; }[][] | OptionalDefault— | — | node22 · node24 · node26 |
images.meshWarp.controlPoints.xPublished images.meshWarp.controlPoints.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.meshWarp.controlPoints.yPublished images.meshWarp.controlPoints.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.meshWarp.gridXHorizontal mesh grid subdivision count. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.meshWarp.gridYVertical mesh grid subdivision count. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.opacityLayer opacity. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.rotationRotation applied to the layer. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shadowShadow configuration for the image or shape layer. | ShadowOptions | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.blurPublished images.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.borderPositionPublished images.shadow.borderPosition option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.borderRadiusPublished images.shadow.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.colorPublished images.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.gradientPublished images.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.gradient.colorsPublished images.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.shadow.gradient.colors.colorPublished images.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.shadow.gradient.colors.stopPublished images.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.shadow.gradient.endXPublished images.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.gradient.endYPublished images.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.gradient.pivotXPublished images.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.gradient.pivotYPublished images.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.gradient.repeatPublished images.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
images.shadow.gradient.rotatePublished images.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.gradient.startXPublished images.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.gradient.startYPublished images.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.gradient.typePublished images.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
images.shadow.gradient.endRadiusPublished images.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.gradient.startRadiusPublished images.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.gradient.centerXPublished images.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.gradient.centerYPublished images.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.gradient.startAnglePublished images.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.offsetXPublished images.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.offsetYPublished images.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.opacityPublished images.shadow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shadow.roundedCornersPublished images.shadow.roundedCorners option. | string | OptionalDefault— | — | node22 · node24 · node26 |
images.shapeShape-specific fill/geometry configuration when source is a declared ShapeType. | ShapeProperties | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.centerXPublished images.shape.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.centerYPublished images.shape.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.colorPublished images.shape.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.endAnglePublished images.shape.endAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.fillPublished images.shape.fill option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
images.shape.gradientPublished images.shape.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.gradient.colorsPublished images.shape.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.shape.gradient.colors.colorPublished images.shape.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.shape.gradient.colors.stopPublished images.shape.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.shape.gradient.endXPublished images.shape.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.gradient.endYPublished images.shape.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.gradient.pivotXPublished images.shape.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.gradient.pivotYPublished images.shape.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.gradient.repeatPublished images.shape.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
images.shape.gradient.rotatePublished images.shape.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.gradient.startXPublished images.shape.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.gradient.startYPublished images.shape.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.gradient.typePublished images.shape.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
images.shape.gradient.endRadiusPublished images.shape.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.gradient.startRadiusPublished images.shape.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.gradient.centerXPublished images.shape.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.gradient.centerYPublished images.shape.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.gradient.startAnglePublished images.shape.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.innerRadiusPublished images.shape.innerRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.outerRadiusPublished images.shape.outerRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.pointsPublished images.shape.points option. | { x: number; y: number; }[] | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.points.xPublished images.shape.points.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.shape.points.yPublished images.shape.points.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.shape.radiusPublished images.shape.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.sidesPublished images.shape.sides option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.shape.startAnglePublished images.shape.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.sourceImage source, Buffer, or declared shape kind to draw. | string | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.strokeStroke configuration for the image or shape layer. | StrokeOptions | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.blurPublished images.stroke.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.borderPositionPublished images.stroke.borderPosition option. | string | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.borderRadiusPublished images.stroke.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.colorPublished images.stroke.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.gradientPublished images.stroke.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.gradient.colorsPublished images.stroke.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.stroke.gradient.colors.colorPublished images.stroke.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.stroke.gradient.colors.stopPublished images.stroke.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.stroke.gradient.endXPublished images.stroke.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.gradient.endYPublished images.stroke.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.gradient.pivotXPublished images.stroke.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.gradient.pivotYPublished images.stroke.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.gradient.repeatPublished images.stroke.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
images.stroke.gradient.rotatePublished images.stroke.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.gradient.startXPublished images.stroke.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.gradient.startYPublished images.stroke.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.gradient.typePublished images.stroke.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
images.stroke.gradient.endRadiusPublished images.stroke.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.gradient.startRadiusPublished images.stroke.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.gradient.centerXPublished images.stroke.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.gradient.centerYPublished images.stroke.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.gradient.startAnglePublished images.stroke.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.opacityPublished images.stroke.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.positionPublished images.stroke.position option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.roundedCornersPublished images.stroke.roundedCorners option. | string | OptionalDefault— | — | node22 · node24 · node26 |
images.stroke.stylePublished images.stroke.style option. | "solid" | "dashed" | "dotted" | "groove" | "ridge" | "double" | OptionalDefault— | 6 values"solid" "dashed" "dotted" "groove" "ridge" "double" | node22 · node24 · node26 |
images.stroke.widthPublished images.stroke.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.widthOptional destination width; validated against runtime canvas limits. | number | OptionalDefault— | — | node22 · node24 · node26 |
images.xDestination x coordinate in canvas pixels. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
images.yDestination y coordinate in canvas pixels. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
| canvasBuffer | ||||
canvasBuffer.bufferPublished canvasBuffer.buffer option. | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvasPublished canvasBuffer.canvas option. | CanvasConfig | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayersPublished canvasBuffer.canvas.bgLayers option. | BackgroundLayer[] | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.blendModePublished canvasBuffer.canvas.bgLayers.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.opacityPublished canvasBuffer.canvas.bgLayers.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.typePublished canvasBuffer.canvas.bgLayers.type option. | "color" | RequiredDefaultRequired | "color" | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.valuePublished canvasBuffer.canvas.bgLayers.value option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.alignPublished canvasBuffer.canvas.bgLayers.align option. | AlignMode | OptionalDefault— | 9 values"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.fitPublished canvasBuffer.canvas.bgLayers.fit option. | "fill" | "contain" | "cover" | OptionalDefault— | "fill" "contain" "cover" | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.sourcePublished canvasBuffer.canvas.bgLayers.source option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.repeatPublished canvasBuffer.canvas.bgLayers.repeat option. | BackgroundPatternRepeat | OptionalDefault— | "repeat" "no-repeat" "repeat-x" "repeat-y" | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.patternPublished canvasBuffer.canvas.bgLayers.pattern option. | PatternOptions | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.blendModePublished canvasBuffer.canvas.bgLayers.pattern.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.colorPublished canvasBuffer.canvas.bgLayers.pattern.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.customPatternImagePublished canvasBuffer.canvas.bgLayers.pattern.customPatternImage option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradientPublished canvasBuffer.canvas.bgLayers.pattern.gradient option. | GradientConfig | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.anglePublished canvasBuffer.canvas.bgLayers.pattern.gradient.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.centerXPublished canvasBuffer.canvas.bgLayers.pattern.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.centerYPublished canvasBuffer.canvas.bgLayers.pattern.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.colorsPublished canvasBuffer.canvas.bgLayers.pattern.gradient.colors option. | { stop: number; color: string; }[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.colors.colorPublished canvasBuffer.canvas.bgLayers.pattern.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.colors.stopPublished canvasBuffer.canvas.bgLayers.pattern.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.endRadiusPublished canvasBuffer.canvas.bgLayers.pattern.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.endXPublished canvasBuffer.canvas.bgLayers.pattern.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.endYPublished canvasBuffer.canvas.bgLayers.pattern.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.repeatPublished canvasBuffer.canvas.bgLayers.pattern.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.startAnglePublished canvasBuffer.canvas.bgLayers.pattern.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.startRadiusPublished canvasBuffer.canvas.bgLayers.pattern.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.startXPublished canvasBuffer.canvas.bgLayers.pattern.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.startYPublished canvasBuffer.canvas.bgLayers.pattern.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.typePublished canvasBuffer.canvas.bgLayers.pattern.gradient.type option. | "linear" | "radial" | "conic" | RequiredDefaultRequired | "linear" "radial" "conic" | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.offsetXPublished canvasBuffer.canvas.bgLayers.pattern.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.offsetYPublished canvasBuffer.canvas.bgLayers.pattern.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.opacityPublished canvasBuffer.canvas.bgLayers.pattern.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.repeatPublished canvasBuffer.canvas.bgLayers.pattern.repeat option. | "repeat" | "no-repeat" | "repeat-x" | "repeat-y" | OptionalDefault— | "repeat" "no-repeat" "repeat-x" "repeat-y" | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.rotationPublished canvasBuffer.canvas.bgLayers.pattern.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.scalePublished canvasBuffer.canvas.bgLayers.pattern.scale option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.secondaryColorPublished canvasBuffer.canvas.bgLayers.pattern.secondaryColor option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.sizePublished canvasBuffer.canvas.bgLayers.pattern.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.spacingPublished canvasBuffer.canvas.bgLayers.pattern.spacing option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.typePublished canvasBuffer.canvas.bgLayers.pattern.type option. | "grid" | "dots" | "diagonal" | "stripes" | "waves" | "crosses" | "hexagons" | "checkerboard" | "diamonds" | "triangles" | "stars" | "polka" | "custom" | RequiredDefaultRequired | 13 values"grid" "dots" "diagonal" "stripes" "waves" "crosses" "hexagons" "checkerboard" "diamonds" "triangles" "stars" "polka" "custom" | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.intensityPublished canvasBuffer.canvas.bgLayers.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.blendModePublished canvasBuffer.canvas.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
canvasBuffer.canvas.blurPublished canvasBuffer.canvas.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.borderPositionPublished canvasBuffer.canvas.borderPosition option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.borderRadiusPublished canvasBuffer.canvas.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.colorBgPublished canvasBuffer.canvas.colorBg option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBgPublished canvasBuffer.canvas.customBg option. | CanvasCustomBackground | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.alignPlacement used by `contain` / `cover` when `inherit` is false. | AlignMode | OptionalDefault— | 9 values"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filtersImage filters applied to this background only. | ImageFilter[] | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.anglePublished canvasBuffer.canvas.customBg.filters.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.centerXPublished canvasBuffer.canvas.customBg.filters.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.centerYPublished canvasBuffer.canvas.customBg.filters.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.heightPublished canvasBuffer.canvas.customBg.filters.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.intensityPublished canvasBuffer.canvas.customBg.filters.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.levelsPublished canvasBuffer.canvas.customBg.filters.levels option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.radiusPublished canvasBuffer.canvas.customBg.filters.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.sizePublished canvasBuffer.canvas.customBg.filters.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.typePublished canvasBuffer.canvas.customBg.filters.type option. | "saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize" | RequiredDefaultRequired | 17 values"saturation" "gaussianBlur" "motionBlur" "radialBlur" "sharpen" "noise" "grain" "edgeDetection" "emboss" "invert" "grayscale" "sepia" "pixelate" "brightness" "contrast" "hueShift" "posterize" | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.valuePublished canvasBuffer.canvas.customBg.filters.value option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.widthPublished canvasBuffer.canvas.customBg.filters.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.xOptional pixelate region. Omit for the whole filtered surface. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.yPublished canvasBuffer.canvas.customBg.filters.y option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.fitResize policy when `inherit` is false. | FitMode | OptionalDefault— | "fill" "contain" "cover" | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.inheritAdopt the source image dimensions as the canvas dimensions. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.opacityBackground-image opacity, multiplied by the canvas-level opacity. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.sourcePublished canvasBuffer.canvas.customBg.source option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBgPublished canvasBuffer.canvas.gradientBg option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.colorsPublished canvasBuffer.canvas.gradientBg.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.colors.colorPublished canvasBuffer.canvas.gradientBg.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.colors.stopPublished canvasBuffer.canvas.gradientBg.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.endXPublished canvasBuffer.canvas.gradientBg.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.endYPublished canvasBuffer.canvas.gradientBg.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.pivotXPublished canvasBuffer.canvas.gradientBg.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.pivotYPublished canvasBuffer.canvas.gradientBg.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.repeatPublished canvasBuffer.canvas.gradientBg.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.rotatePublished canvasBuffer.canvas.gradientBg.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.startXPublished canvasBuffer.canvas.gradientBg.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.startYPublished canvasBuffer.canvas.gradientBg.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.typePublished canvasBuffer.canvas.gradientBg.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.endRadiusPublished canvasBuffer.canvas.gradientBg.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.startRadiusPublished canvasBuffer.canvas.gradientBg.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.centerXPublished canvasBuffer.canvas.gradientBg.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.centerYPublished canvasBuffer.canvas.gradientBg.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.startAnglePublished canvasBuffer.canvas.gradientBg.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.heightPublished canvasBuffer.canvas.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.noiseBgPublished canvasBuffer.canvas.noiseBg option. | { intensity?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.noiseBg.intensityPublished canvasBuffer.canvas.noiseBg.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.opacityPublished canvasBuffer.canvas.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBgPublished canvasBuffer.canvas.patternBg option. | PatternOptions | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.blendModePublished canvasBuffer.canvas.patternBg.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.colorPublished canvasBuffer.canvas.patternBg.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.customPatternImagePublished canvasBuffer.canvas.patternBg.customPatternImage option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradientPublished canvasBuffer.canvas.patternBg.gradient option. | GradientConfig | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.anglePublished canvasBuffer.canvas.patternBg.gradient.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.centerXPublished canvasBuffer.canvas.patternBg.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.centerYPublished canvasBuffer.canvas.patternBg.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.colorsPublished canvasBuffer.canvas.patternBg.gradient.colors option. | { stop: number; color: string; }[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.colors.colorPublished canvasBuffer.canvas.patternBg.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.colors.stopPublished canvasBuffer.canvas.patternBg.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.endRadiusPublished canvasBuffer.canvas.patternBg.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.endXPublished canvasBuffer.canvas.patternBg.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.endYPublished canvasBuffer.canvas.patternBg.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.repeatPublished canvasBuffer.canvas.patternBg.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.startAnglePublished canvasBuffer.canvas.patternBg.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.startRadiusPublished canvasBuffer.canvas.patternBg.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.startXPublished canvasBuffer.canvas.patternBg.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.startYPublished canvasBuffer.canvas.patternBg.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.typePublished canvasBuffer.canvas.patternBg.gradient.type option. | "linear" | "radial" | "conic" | RequiredDefaultRequired | "linear" "radial" "conic" | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.offsetXPublished canvasBuffer.canvas.patternBg.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.offsetYPublished canvasBuffer.canvas.patternBg.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.opacityPublished canvasBuffer.canvas.patternBg.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.repeatPublished canvasBuffer.canvas.patternBg.repeat option. | "repeat" | "no-repeat" | "repeat-x" | "repeat-y" | OptionalDefault— | "repeat" "no-repeat" "repeat-x" "repeat-y" | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.rotationPublished canvasBuffer.canvas.patternBg.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.scalePublished canvasBuffer.canvas.patternBg.scale option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.secondaryColorPublished canvasBuffer.canvas.patternBg.secondaryColor option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.sizePublished canvasBuffer.canvas.patternBg.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.spacingPublished canvasBuffer.canvas.patternBg.spacing option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.typePublished canvasBuffer.canvas.patternBg.type option. | "grid" | "dots" | "diagonal" | "stripes" | "waves" | "crosses" | "hexagons" | "checkerboard" | "diamonds" | "triangles" | "stars" | "polka" | "custom" | RequiredDefaultRequired | 13 values"grid" "dots" "diagonal" "stripes" "waves" "crosses" "hexagons" "checkerboard" "diamonds" "triangles" "stars" "polka" "custom" | node22 · node24 · node26 |
canvasBuffer.canvas.rotationPublished canvasBuffer.canvas.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadowPublished canvasBuffer.canvas.shadow option. | ShadowOptions | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.blurPublished canvasBuffer.canvas.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.borderPositionPublished canvasBuffer.canvas.shadow.borderPosition option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.borderRadiusPublished canvasBuffer.canvas.shadow.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.colorPublished canvasBuffer.canvas.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradientPublished canvasBuffer.canvas.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.colorsPublished canvasBuffer.canvas.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.colors.colorPublished canvasBuffer.canvas.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.colors.stopPublished canvasBuffer.canvas.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.endXPublished canvasBuffer.canvas.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.endYPublished canvasBuffer.canvas.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.pivotXPublished canvasBuffer.canvas.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.pivotYPublished canvasBuffer.canvas.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.repeatPublished canvasBuffer.canvas.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.rotatePublished canvasBuffer.canvas.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.startXPublished canvasBuffer.canvas.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.startYPublished canvasBuffer.canvas.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.typePublished canvasBuffer.canvas.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.endRadiusPublished canvasBuffer.canvas.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.startRadiusPublished canvasBuffer.canvas.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.centerXPublished canvasBuffer.canvas.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.centerYPublished canvasBuffer.canvas.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.startAnglePublished canvasBuffer.canvas.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.offsetXPublished canvasBuffer.canvas.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.offsetYPublished canvasBuffer.canvas.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.opacityPublished canvasBuffer.canvas.shadow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.roundedCornersPublished canvasBuffer.canvas.shadow.roundedCorners option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.strokePublished canvasBuffer.canvas.stroke option. | StrokeOptions | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.blurPublished canvasBuffer.canvas.stroke.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.borderPositionPublished canvasBuffer.canvas.stroke.borderPosition option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.borderRadiusPublished canvasBuffer.canvas.stroke.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.colorPublished canvasBuffer.canvas.stroke.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradientPublished canvasBuffer.canvas.stroke.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.colorsPublished canvasBuffer.canvas.stroke.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.colors.colorPublished canvasBuffer.canvas.stroke.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.colors.stopPublished canvasBuffer.canvas.stroke.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.endXPublished canvasBuffer.canvas.stroke.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.endYPublished canvasBuffer.canvas.stroke.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.pivotXPublished canvasBuffer.canvas.stroke.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.pivotYPublished canvasBuffer.canvas.stroke.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.repeatPublished canvasBuffer.canvas.stroke.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.rotatePublished canvasBuffer.canvas.stroke.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.startXPublished canvasBuffer.canvas.stroke.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.startYPublished canvasBuffer.canvas.stroke.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.typePublished canvasBuffer.canvas.stroke.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.endRadiusPublished canvasBuffer.canvas.stroke.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.startRadiusPublished canvasBuffer.canvas.stroke.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.centerXPublished canvasBuffer.canvas.stroke.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.centerYPublished canvasBuffer.canvas.stroke.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.startAnglePublished canvasBuffer.canvas.stroke.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.opacityPublished canvasBuffer.canvas.stroke.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.positionPublished canvasBuffer.canvas.stroke.position option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.roundedCornersPublished canvasBuffer.canvas.stroke.roundedCorners option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.stylePublished canvasBuffer.canvas.stroke.style option. | "solid" | "dashed" | "dotted" | "groove" | "ridge" | "double" | OptionalDefault— | 6 values"solid" "dashed" "dotted" "groove" "ridge" "double" | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.widthPublished canvasBuffer.canvas.stroke.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.transparentBasePublished canvasBuffer.canvas.transparentBase option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
canvasBuffer.canvas.videoBgPublished canvasBuffer.canvas.videoBg option. | CanvasVideoBackground | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.alignPlacement used by `contain` / `cover` when `inherit` is false. | AlignMode | OptionalDefault— | 9 values"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.autoplayPublished canvasBuffer.canvas.videoBg.autoplay option.Deprecated | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filtersImage filters applied to this background only. | ImageFilter[] | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.anglePublished canvasBuffer.canvas.videoBg.filters.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.centerXPublished canvasBuffer.canvas.videoBg.filters.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.centerYPublished canvasBuffer.canvas.videoBg.filters.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.heightPublished canvasBuffer.canvas.videoBg.filters.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.intensityPublished canvasBuffer.canvas.videoBg.filters.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.levelsPublished canvasBuffer.canvas.videoBg.filters.levels option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.radiusPublished canvasBuffer.canvas.videoBg.filters.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.sizePublished canvasBuffer.canvas.videoBg.filters.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.typePublished canvasBuffer.canvas.videoBg.filters.type option. | "saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize" | RequiredDefaultRequired | 17 values"saturation" "gaussianBlur" "motionBlur" "radialBlur" "sharpen" "noise" "grain" "edgeDetection" "emboss" "invert" "grayscale" "sepia" "pixelate" "brightness" "contrast" "hueShift" "posterize" | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.valuePublished canvasBuffer.canvas.videoBg.filters.value option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.widthPublished canvasBuffer.canvas.videoBg.filters.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.xOptional pixelate region. Omit for the whole filtered surface. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.yPublished canvasBuffer.canvas.videoBg.filters.y option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.fitResize policy when `inherit` is false. | FitMode | OptionalDefault— | "fill" "contain" "cover" | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.formatPublished canvasBuffer.canvas.videoBg.format option. | "jpg" | "png" | OptionalDefault— | "jpg" "png" | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.frame1-based frame number. Mutually exclusive with `time`. Defaults to frame 1 when neither selector is provided. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.inheritAdopt the source image dimensions as the canvas dimensions. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.loopPublished canvasBuffer.canvas.videoBg.loop option.Deprecated | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.opacityBackground-image opacity, multiplied by the canvas-level opacity. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.qualityFFmpeg image quality value from 1 (best) through 31. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.sourcePublished canvasBuffer.canvas.videoBg.source option. | string | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.timeTimestamp in seconds. Mutually exclusive with `frame`. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.widthPublished canvasBuffer.canvas.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.xPublished canvasBuffer.canvas.x option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.yPublished canvasBuffer.canvas.y option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.zoomPublished canvasBuffer.canvas.zoom option. | { scale?: number; centerX?: number; centerY?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.zoom.centerXPublished canvasBuffer.canvas.zoom.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.zoom.centerYPublished canvasBuffer.canvas.zoom.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.zoom.scalePublished canvasBuffer.canvas.zoom.scale option. | number | OptionalDefault— | — | node22 · node24 · node26 |
| options | ||||
options.groupTransformTransform/effect configuration applied to a grouped image set. | GroupTransformOptions | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.blendModePublished options.groupTransform.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
options.groupTransform.blurPublished options.groupTransform.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.borderPositionPublished options.groupTransform.borderPosition option. | string | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.borderRadiusPublished options.groupTransform.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.boxBackgroundPublished options.groupTransform.boxBackground option. | BoxBackground | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.boxBackground.colorPublished options.groupTransform.boxBackground.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.boxBackground.gradientPublished options.groupTransform.boxBackground.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.boxBackground.gradient.colorsPublished options.groupTransform.boxBackground.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.boxBackground.gradient.colors.colorPublished options.groupTransform.boxBackground.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.boxBackground.gradient.colors.stopPublished options.groupTransform.boxBackground.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.boxBackground.gradient.endXPublished options.groupTransform.boxBackground.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.boxBackground.gradient.endYPublished options.groupTransform.boxBackground.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.boxBackground.gradient.pivotXPublished options.groupTransform.boxBackground.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.boxBackground.gradient.pivotYPublished options.groupTransform.boxBackground.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.boxBackground.gradient.repeatPublished options.groupTransform.boxBackground.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
options.groupTransform.boxBackground.gradient.rotatePublished options.groupTransform.boxBackground.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.boxBackground.gradient.startXPublished options.groupTransform.boxBackground.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.boxBackground.gradient.startYPublished options.groupTransform.boxBackground.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.boxBackground.gradient.typePublished options.groupTransform.boxBackground.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
options.groupTransform.boxBackground.gradient.endRadiusPublished options.groupTransform.boxBackground.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.boxBackground.gradient.startRadiusPublished options.groupTransform.boxBackground.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.boxBackground.gradient.centerXPublished options.groupTransform.boxBackground.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.boxBackground.gradient.centerYPublished options.groupTransform.boxBackground.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.boxBackground.gradient.startAnglePublished options.groupTransform.boxBackground.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.clipPathPublished options.groupTransform.clipPath option. | { x: number; y: number; }[] | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.clipPath.xPublished options.groupTransform.clipPath.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.clipPath.yPublished options.groupTransform.clipPath.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.distortionPublished options.groupTransform.distortion option. | { type: "perspective" | "warp" | "bulge" | "pinch"; points?: { x: number; y: number; }[]; intensity?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.distortion.intensityPublished options.groupTransform.distortion.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.distortion.pointsPublished options.groupTransform.distortion.points option. | { x: number; y: number; }[] | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.distortion.points.xPublished options.groupTransform.distortion.points.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.distortion.points.yPublished options.groupTransform.distortion.points.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.distortion.typePublished options.groupTransform.distortion.type option. | "perspective" | "warp" | "bulge" | "pinch" | RequiredDefaultRequired | "perspective" "warp" "bulge" "pinch" | node22 · node24 · node26 |
options.groupTransform.effectsPublished options.groupTransform.effects option. | { vignette?: { intensity: number; size: number; }; lensFlare?: { x: number; y: number; intensity: number; }; chromaticAberration?: { intensity: number; }; filmGrain?: { intensity: number; }; } | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.effects.chromaticAberrationPublished options.groupTransform.effects.chromaticAberration option. | { intensity: number; } | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.effects.chromaticAberration.intensityPublished options.groupTransform.effects.chromaticAberration.intensity option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.effects.filmGrainPublished options.groupTransform.effects.filmGrain option. | { intensity: number; } | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.effects.filmGrain.intensityPublished options.groupTransform.effects.filmGrain.intensity option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.effects.lensFlarePublished options.groupTransform.effects.lensFlare option. | { x: number; y: number; intensity: number; } | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.effects.lensFlare.intensityPublished options.groupTransform.effects.lensFlare.intensity option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.effects.lensFlare.xPublished options.groupTransform.effects.lensFlare.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.effects.lensFlare.yPublished options.groupTransform.effects.lensFlare.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.effects.vignettePublished options.groupTransform.effects.vignette option. | { intensity: number; size: number; } | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.effects.vignette.intensityPublished options.groupTransform.effects.vignette.intensity option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.effects.vignette.sizePublished options.groupTransform.effects.vignette.size option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.filterIntensityPublished options.groupTransform.filterIntensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.filterOrderPublished options.groupTransform.filterOrder option. | "pre" | "post" | OptionalDefault— | "pre" "post" | node22 · node24 · node26 |
options.groupTransform.filtersPublished options.groupTransform.filters option. | ImageFilter[] | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.filters.anglePublished options.groupTransform.filters.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.filters.centerXPublished options.groupTransform.filters.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.filters.centerYPublished options.groupTransform.filters.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.filters.heightPublished options.groupTransform.filters.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.filters.intensityPublished options.groupTransform.filters.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.filters.levelsPublished options.groupTransform.filters.levels option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.filters.radiusPublished options.groupTransform.filters.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.filters.sizePublished options.groupTransform.filters.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.filters.typePublished options.groupTransform.filters.type option. | "saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize" | RequiredDefaultRequired | 17 values"saturation" "gaussianBlur" "motionBlur" "radialBlur" "sharpen" "noise" "grain" "edgeDetection" "emboss" "invert" "grayscale" "sepia" "pixelate" "brightness" "contrast" "hueShift" "posterize" | node22 · node24 · node26 |
options.groupTransform.filters.valuePublished options.groupTransform.filters.value option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.filters.widthPublished options.groupTransform.filters.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.filters.xOptional pixelate region. Omit for the whole filtered surface. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.filters.yPublished options.groupTransform.filters.y option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.maskPublished options.groupTransform.mask option. | { source: string | Buffer<ArrayBufferLike>; mode?: "alpha" | "luminance" | "inverse"; } | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.mask.modePublished options.groupTransform.mask.mode option. | "alpha" | "luminance" | "inverse" | OptionalDefault— | "alpha" "luminance" "inverse" | node22 · node24 · node26 |
options.groupTransform.mask.sourcePublished options.groupTransform.mask.source option. | string | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.meshWarpPublished options.groupTransform.meshWarp option. | { gridX?: number; gridY?: number; controlPoints?: { x: number; y: number; }[][]; } | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.meshWarp.controlPointsPublished options.groupTransform.meshWarp.controlPoints option. | { x: number; y: number; }[][] | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.meshWarp.controlPoints.xPublished options.groupTransform.meshWarp.controlPoints.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.meshWarp.controlPoints.yPublished options.groupTransform.meshWarp.controlPoints.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.meshWarp.gridXPublished options.groupTransform.meshWarp.gridX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.meshWarp.gridYPublished options.groupTransform.meshWarp.gridY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.opacityPublished options.groupTransform.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.pivotXPublished options.groupTransform.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.pivotYPublished options.groupTransform.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.rotationPublished options.groupTransform.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.scaleXPublished options.groupTransform.scaleX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.scaleYPublished options.groupTransform.scaleY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadowPublished options.groupTransform.shadow option. | ShadowOptions | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.blurPublished options.groupTransform.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.borderPositionPublished options.groupTransform.shadow.borderPosition option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.borderRadiusPublished options.groupTransform.shadow.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.colorPublished options.groupTransform.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.gradientPublished options.groupTransform.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.gradient.colorsPublished options.groupTransform.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.shadow.gradient.colors.colorPublished options.groupTransform.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.shadow.gradient.colors.stopPublished options.groupTransform.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.shadow.gradient.endXPublished options.groupTransform.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.gradient.endYPublished options.groupTransform.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.gradient.pivotXPublished options.groupTransform.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.gradient.pivotYPublished options.groupTransform.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.gradient.repeatPublished options.groupTransform.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
options.groupTransform.shadow.gradient.rotatePublished options.groupTransform.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.gradient.startXPublished options.groupTransform.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.gradient.startYPublished options.groupTransform.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.gradient.typePublished options.groupTransform.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
options.groupTransform.shadow.gradient.endRadiusPublished options.groupTransform.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.gradient.startRadiusPublished options.groupTransform.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.gradient.centerXPublished options.groupTransform.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.gradient.centerYPublished options.groupTransform.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.gradient.startAnglePublished options.groupTransform.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.offsetXPublished options.groupTransform.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.offsetYPublished options.groupTransform.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.opacityPublished options.groupTransform.shadow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.shadow.roundedCornersPublished options.groupTransform.shadow.roundedCorners option. | string | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.strokePublished options.groupTransform.stroke option. | StrokeOptions | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.blurPublished options.groupTransform.stroke.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.borderPositionPublished options.groupTransform.stroke.borderPosition option. | string | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.borderRadiusPublished options.groupTransform.stroke.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.colorPublished options.groupTransform.stroke.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.gradientPublished options.groupTransform.stroke.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.gradient.colorsPublished options.groupTransform.stroke.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.stroke.gradient.colors.colorPublished options.groupTransform.stroke.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.stroke.gradient.colors.stopPublished options.groupTransform.stroke.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
options.groupTransform.stroke.gradient.endXPublished options.groupTransform.stroke.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.gradient.endYPublished options.groupTransform.stroke.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.gradient.pivotXPublished options.groupTransform.stroke.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.gradient.pivotYPublished options.groupTransform.stroke.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.gradient.repeatPublished options.groupTransform.stroke.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
options.groupTransform.stroke.gradient.rotatePublished options.groupTransform.stroke.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.gradient.startXPublished options.groupTransform.stroke.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.gradient.startYPublished options.groupTransform.stroke.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.gradient.typePublished options.groupTransform.stroke.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
options.groupTransform.stroke.gradient.endRadiusPublished options.groupTransform.stroke.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.gradient.startRadiusPublished options.groupTransform.stroke.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.gradient.centerXPublished options.groupTransform.stroke.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.gradient.centerYPublished options.groupTransform.stroke.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.gradient.startAnglePublished options.groupTransform.stroke.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.opacityPublished options.groupTransform.stroke.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.positionPublished options.groupTransform.stroke.position option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.roundedCornersPublished options.groupTransform.stroke.roundedCorners option. | string | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.stroke.stylePublished options.groupTransform.stroke.style option. | "solid" | "dashed" | "dotted" | "groove" | "ridge" | "double" | OptionalDefault— | 6 values"solid" "dashed" "dotted" "groove" "ridge" "double" | node22 · node24 · node26 |
options.groupTransform.stroke.widthPublished options.groupTransform.stroke.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.translateXPublished options.groupTransform.translateX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.groupTransform.translateYPublished options.groupTransform.translateY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.isGroupedTreat multiple image layers as a transformable group. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
| painterOpts | ||||
painterOpts.resolveAssetRefsResolve named Apexify asset references before rendering. | boolean | OptionalDefaultfalse | false true | node22 · node24 · node26 |
images.align
OptionalAlignment used when fitted source dimensions do not exactly match the destination box.
- Type
AlignMode- Default
"center"- Allowed
9 values
"center""top""bottom""left""right""top-left""top-right""bottom-left""bottom-right"- Runtime
- node22, node24, node26
images.blendMode
OptionalCanvas composite operation used for the layer.
- Type
GlobalCompositeOperation- Default
- —
- Allowed
26 values
"color""color-burn""color-dodge""copy""darken""destination-atop""destination-in""destination-out""destination-over""difference""exclusion""hard-light""hue""lighten""lighter""luminosity""multiply""overlay""saturation""screen""soft-light""source-atop""source-in""source-out""source-over""xor"- Runtime
- node22, node24, node26
images.blur
OptionalLayer blur amount.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.borderPosition
OptionalBorder/corner positioning hint used by rounded rendering helpers.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.borderRadius
OptionalLayer clipping radius or circular clipping mode.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.boxBackground
OptionalOptional background fill behind the layer box.
- Type
BoxBackground- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.boxBackground.color
OptionalPublished images.boxBackground.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.boxBackground.gradient
OptionalPublished images.boxBackground.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.boxBackground.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.boxBackground.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.boxBackground.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.boxBackground.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.boxBackground.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.boxBackground.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.boxBackground.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.boxBackground.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published images.boxBackground.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.boxBackground.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.boxBackground.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.boxBackground.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published images.boxBackground.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.boxBackground.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.boxBackground.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.boxBackground.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.boxBackground.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.clipPath
OptionalPolygon points used to clip the layer.
- Type
{ x: number; y: number; }[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.clipPath.x
RequiredPublished images.clipPath.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.clipPath.y
RequiredPublished images.clipPath.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.distortion
OptionalOptional perspective/warp/bulge/pinch distortion configuration.
- Type
{ type: "perspective" | "warp" | "bulge" | "pinch"; points?: { x: number; y: number; }[]; intensity?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.distortion.intensity
OptionalDistortion strength where supported.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.distortion.points
OptionalControl points used by distortion modes that require them.
- Type
{ x: number; y: number; }[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.distortion.points.x
RequiredPublished images.distortion.points.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.distortion.points.y
RequiredPublished images.distortion.points.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.distortion.type
RequiredDistortion algorithm.
- Type
"perspective" | "warp" | "bulge" | "pinch"- Default
- Required
- Allowed
"perspective""warp""bulge""pinch"- Runtime
- node22, node24, node26
images.effects
OptionalOptional post-processing visual effects.
- Type
{ vignette?: { intensity: number; size: number; }; lensFlare?: { x: number; y: number; intensity: number; }; chromaticAberration?: { intensity: number; }; filmGrain?: { intensity: number; }; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Chromatic-aberration effect settings.
- Type
{ intensity: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Chromatic-aberration intensity.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.effects.filmGrain
OptionalFilm-grain effect settings.
- Type
{ intensity: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Film-grain intensity.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.effects.lensFlare
OptionalLens-flare effect settings.
- Type
{ x: number; y: number; intensity: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Lens-flare intensity.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.effects.lensFlare.x
RequiredLens-flare x coordinate.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.effects.lensFlare.y
RequiredLens-flare y coordinate.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.effects.vignette
OptionalVignette effect settings.
- Type
{ intensity: number; size: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Vignette intensity.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.effects.vignette.size
RequiredVignette size.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.filterIntensity
OptionalShared filter intensity value where supported by the selected filter.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.filterOrder
OptionalWhether filters are applied before or after other image processing stages.
- Type
"pre" | "post"- Default
- —
- Allowed
"pre""post"- Runtime
- node22, node24, node26
images.filters
OptionalOrdered image-filter operations applied to the layer.
- Type
ImageFilter[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.filters.angle
OptionalPublished images.filters.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.filters.centerX
OptionalPublished images.filters.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.filters.centerY
OptionalPublished images.filters.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.filters.height
OptionalPublished images.filters.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.filters.intensity
OptionalPublished images.filters.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.filters.levels
OptionalPublished images.filters.levels option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.filters.radius
OptionalPublished images.filters.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.filters.size
OptionalPublished images.filters.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.filters.type
RequiredPublished images.filters.type option.
- Type
"saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize"- Default
- Required
- Allowed
17 values
"saturation""gaussianBlur""motionBlur""radialBlur""sharpen""noise""grain""edgeDetection""emboss""invert""grayscale""sepia""pixelate""brightness""contrast""hueShift""posterize"- Runtime
- node22, node24, node26
images.filters.value
OptionalPublished images.filters.value option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.filters.width
OptionalPublished images.filters.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.filters.x
OptionalOptional pixelate region. Omit for the whole filtered surface.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.filters.y
OptionalPublished images.filters.y option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.fit
OptionalHow source content fits the destination box.
- Type
FitMode- Default
"fill"- Allowed
"fill""contain""cover"- Runtime
- node22, node24, node26
images.height
OptionalOptional destination height; validated against runtime canvas limits.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.inherit
OptionalPreserve source sizing behavior when supported by image composition.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
images.mask
OptionalOptional alpha/luminance mask configuration.
- Type
{ source: string | Buffer<ArrayBufferLike>; mode?: "alpha" | "luminance" | "inverse"; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.mask.mode
OptionalMask interpretation mode.
- Type
"alpha" | "luminance" | "inverse"- Default
"alpha"- Allowed
"alpha""luminance""inverse"- Runtime
- node22, node24, node26
images.mask.source
RequiredImage source used as the mask.
- Type
string | Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.meshWarp
OptionalMesh-warp grid and control-point configuration.
- Type
{ gridX?: number; gridY?: number; controlPoints?: { x: number; y: number; }[][]; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.meshWarp.controlPoints
OptionalNested mesh control-point grid.
- Type
{ x: number; y: number; }[][]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.meshWarp.controlPoints.x
RequiredPublished images.meshWarp.controlPoints.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.meshWarp.controlPoints.y
RequiredPublished images.meshWarp.controlPoints.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.meshWarp.gridX
OptionalHorizontal mesh grid subdivision count.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.meshWarp.gridY
OptionalVertical mesh grid subdivision count.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.opacity
OptionalLayer opacity.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.rotation
OptionalRotation applied to the layer.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow
OptionalShadow configuration for the image or shape layer.
- Type
ShadowOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow.blur
OptionalPublished images.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow.borderPosition
OptionalPublished images.shadow.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow.borderRadius
OptionalPublished images.shadow.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow.color
OptionalPublished images.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow.gradient
OptionalPublished images.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow.gradient.colors
RequiredPublished images.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow.gradient.endX
OptionalPublished images.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow.gradient.endY
OptionalPublished images.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow.gradient.pivotX
OptionalPublished images.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow.gradient.pivotY
OptionalPublished images.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow.gradient.repeat
OptionalPublished images.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
images.shadow.gradient.rotate
OptionalPublished images.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow.gradient.startX
OptionalPublished images.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow.gradient.startY
OptionalPublished images.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow.gradient.type
RequiredPublished images.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
images.shadow.gradient.endRadius
OptionalPublished images.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow.gradient.centerX
OptionalPublished images.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow.gradient.centerY
OptionalPublished images.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow.offsetX
OptionalPublished images.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow.offsetY
OptionalPublished images.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow.opacity
OptionalPublished images.shadow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shadow.roundedCorners
OptionalPublished images.shadow.roundedCorners option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape
OptionalShape-specific fill/geometry configuration when source is a declared ShapeType.
- Type
ShapeProperties- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.centerX
OptionalPublished images.shape.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.centerY
OptionalPublished images.shape.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.color
OptionalPublished images.shape.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.endAngle
OptionalPublished images.shape.endAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.fill
OptionalPublished images.shape.fill option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
images.shape.gradient
OptionalPublished images.shape.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.gradient.colors
RequiredPublished images.shape.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.shape.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.shape.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.gradient.endX
OptionalPublished images.shape.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.gradient.endY
OptionalPublished images.shape.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.gradient.pivotX
OptionalPublished images.shape.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.gradient.pivotY
OptionalPublished images.shape.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.gradient.repeat
OptionalPublished images.shape.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
images.shape.gradient.rotate
OptionalPublished images.shape.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.gradient.startX
OptionalPublished images.shape.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.gradient.startY
OptionalPublished images.shape.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.gradient.type
RequiredPublished images.shape.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
images.shape.gradient.endRadius
OptionalPublished images.shape.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.shape.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.gradient.centerX
OptionalPublished images.shape.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.gradient.centerY
OptionalPublished images.shape.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.gradient.startAngle
OptionalPublished images.shape.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.innerRadius
OptionalPublished images.shape.innerRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.outerRadius
OptionalPublished images.shape.outerRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.points
OptionalPublished images.shape.points option.
- Type
{ x: number; y: number; }[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.points.x
RequiredPublished images.shape.points.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.points.y
RequiredPublished images.shape.points.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.radius
OptionalPublished images.shape.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.sides
OptionalPublished images.shape.sides option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.shape.startAngle
OptionalPublished images.shape.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.source
RequiredImage source, Buffer, or declared shape kind to draw.
- Type
string | Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke
OptionalStroke configuration for the image or shape layer.
- Type
StrokeOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke.blur
OptionalPublished images.stroke.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke.borderPosition
OptionalPublished images.stroke.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke.borderRadius
OptionalPublished images.stroke.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke.color
OptionalPublished images.stroke.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke.gradient
OptionalPublished images.stroke.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke.gradient.colors
RequiredPublished images.stroke.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.stroke.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.stroke.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke.gradient.endX
OptionalPublished images.stroke.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke.gradient.endY
OptionalPublished images.stroke.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke.gradient.pivotX
OptionalPublished images.stroke.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke.gradient.pivotY
OptionalPublished images.stroke.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke.gradient.repeat
OptionalPublished images.stroke.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
images.stroke.gradient.rotate
OptionalPublished images.stroke.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke.gradient.startX
OptionalPublished images.stroke.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke.gradient.startY
OptionalPublished images.stroke.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke.gradient.type
RequiredPublished images.stroke.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
images.stroke.gradient.endRadius
OptionalPublished images.stroke.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.stroke.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke.gradient.centerX
OptionalPublished images.stroke.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke.gradient.centerY
OptionalPublished images.stroke.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published images.stroke.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke.opacity
OptionalPublished images.stroke.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke.position
OptionalPublished images.stroke.position option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke.roundedCorners
OptionalPublished images.stroke.roundedCorners option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.stroke.style
OptionalPublished images.stroke.style option.
- Type
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"- Default
- —
- Allowed
6 values
"solid""dashed""dotted""groove""ridge""double"- Runtime
- node22, node24, node26
images.stroke.width
OptionalPublished images.stroke.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.width
OptionalOptional destination width; validated against runtime canvas limits.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
images.x
RequiredDestination x coordinate in canvas pixels.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
images.y
RequiredDestination y coordinate in canvas pixels.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.buffer
RequiredPublished canvasBuffer.buffer option.
- Type
Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas
RequiredPublished canvasBuffer.canvas option.
- Type
CanvasConfig- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.bgLayers
OptionalPublished canvasBuffer.canvas.bgLayers option.
- Type
BackgroundLayer[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.blendMode option.
- Type
GlobalCompositeOperation- Default
- —
- Allowed
26 values
"color""color-burn""color-dodge""copy""darken""destination-atop""destination-in""destination-out""destination-over""difference""exclusion""hard-light""hue""lighten""lighter""luminosity""multiply""overlay""saturation""screen""soft-light""source-atop""source-in""source-out""source-over""xor"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.type option.
- Type
"color"- Default
- Required
- Allowed
"color"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.value option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.align option.
- Type
AlignMode- Default
- —
- Allowed
9 values
"center""top""bottom""left""right""top-left""top-right""bottom-left""bottom-right"- Runtime
- node22, node24, node26
canvasBuffer.canvas.bgLayers.fit
OptionalPublished canvasBuffer.canvas.bgLayers.fit option.
- Type
"fill" | "contain" | "cover"- Default
- —
- Allowed
"fill""contain""cover"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.source option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.repeat option.
- Type
BackgroundPatternRepeat- Default
- —
- Allowed
"repeat""no-repeat""repeat-x""repeat-y"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern option.
- Type
PatternOptions- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.blendMode option.
- Type
GlobalCompositeOperation- Default
- —
- Allowed
26 values
"color""color-burn""color-dodge""copy""darken""destination-atop""destination-in""destination-out""destination-over""difference""exclusion""hard-light""hue""lighten""lighter""luminosity""multiply""overlay""saturation""screen""soft-light""source-atop""source-in""source-out""source-over""xor"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.customPatternImage option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient option.
- Type
GradientConfig- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.colors option.
- Type
{ stop: number; color: string; }[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.type option.
- Type
"linear" | "radial" | "conic"- Default
- Required
- Allowed
"linear""radial""conic"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.repeat option.
- Type
"repeat" | "no-repeat" | "repeat-x" | "repeat-y"- Default
- —
- Allowed
"repeat""no-repeat""repeat-x""repeat-y"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.scale option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.secondaryColor option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.spacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.type option.
- Type
"grid" | "dots" | "diagonal" | "stripes" | "waves" | "crosses" | "hexagons" | "checkerboard" | "diamonds" | "triangles" | "stars" | "polka" | "custom"- Default
- Required
- Allowed
13 values
"grid""dots""diagonal""stripes""waves""crosses""hexagons""checkerboard""diamonds""triangles""stars""polka""custom"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.blendMode
OptionalPublished canvasBuffer.canvas.blendMode option.
- Type
GlobalCompositeOperation- Default
- —
- Allowed
26 values
"color""color-burn""color-dodge""copy""darken""destination-atop""destination-in""destination-out""destination-over""difference""exclusion""hard-light""hue""lighten""lighter""luminosity""multiply""overlay""saturation""screen""soft-light""source-atop""source-in""source-out""source-over""xor"- Runtime
- node22, node24, node26
canvasBuffer.canvas.blur
OptionalPublished canvasBuffer.canvas.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.borderRadius
OptionalPublished canvasBuffer.canvas.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.colorBg
OptionalPublished canvasBuffer.canvas.colorBg option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.customBg
OptionalPublished canvasBuffer.canvas.customBg option.
- Type
CanvasCustomBackground- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Placement used by `contain` / `cover` when `inherit` is false.
- Type
AlignMode- Default
- —
- Allowed
9 values
"center""top""bottom""left""right""top-left""top-right""bottom-left""bottom-right"- Runtime
- node22, node24, node26
Image filters applied to this background only.
- Type
ImageFilter[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.levels option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.type option.
- Type
"saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize"- Default
- Required
- Allowed
17 values
"saturation""gaussianBlur""motionBlur""radialBlur""sharpen""noise""grain""edgeDetection""emboss""invert""grayscale""sepia""pixelate""brightness""contrast""hueShift""posterize"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.value option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Optional pixelate region. Omit for the whole filtered surface.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.y option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.customBg.fit
OptionalResize policy when `inherit` is false.
- Type
FitMode- Default
- —
- Allowed
"fill""contain""cover"- Runtime
- node22, node24, node26
Adopt the source image dimensions as the canvas dimensions.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Background-image opacity, multiplied by the canvas-level opacity.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.source option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.gradientBg
OptionalPublished canvasBuffer.canvas.gradientBg option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.height
OptionalPublished canvasBuffer.canvas.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.noiseBg
OptionalPublished canvasBuffer.canvas.noiseBg option.
- Type
{ intensity?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.noiseBg.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.opacity
OptionalPublished canvasBuffer.canvas.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.patternBg
OptionalPublished canvasBuffer.canvas.patternBg option.
- Type
PatternOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.blendMode option.
- Type
GlobalCompositeOperation- Default
- —
- Allowed
26 values
"color""color-burn""color-dodge""copy""darken""destination-atop""destination-in""destination-out""destination-over""difference""exclusion""hard-light""hue""lighten""lighter""luminosity""multiply""overlay""saturation""screen""soft-light""source-atop""source-in""source-out""source-over""xor"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.customPatternImage option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient option.
- Type
GradientConfig- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.colors option.
- Type
{ stop: number; color: string; }[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.type option.
- Type
"linear" | "radial" | "conic"- Default
- Required
- Allowed
"linear""radial""conic"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.repeat option.
- Type
"repeat" | "no-repeat" | "repeat-x" | "repeat-y"- Default
- —
- Allowed
"repeat""no-repeat""repeat-x""repeat-y"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.scale option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.secondaryColor option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.spacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.type option.
- Type
"grid" | "dots" | "diagonal" | "stripes" | "waves" | "crosses" | "hexagons" | "checkerboard" | "diamonds" | "triangles" | "stars" | "polka" | "custom"- Default
- Required
- Allowed
13 values
"grid""dots""diagonal""stripes""waves""crosses""hexagons""checkerboard""diamonds""triangles""stars""polka""custom"- Runtime
- node22, node24, node26
canvasBuffer.canvas.rotation
OptionalPublished canvasBuffer.canvas.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.shadow
OptionalPublished canvasBuffer.canvas.shadow option.
- Type
ShadowOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.shadow.blur
OptionalPublished canvasBuffer.canvas.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.shadow.color
OptionalPublished canvasBuffer.canvas.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.roundedCorners option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.stroke
OptionalPublished canvasBuffer.canvas.stroke option.
- Type
StrokeOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.stroke.blur
OptionalPublished canvasBuffer.canvas.stroke.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.stroke.color
OptionalPublished canvasBuffer.canvas.stroke.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.position option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.roundedCorners option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.stroke.style
OptionalPublished canvasBuffer.canvas.stroke.style option.
- Type
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"- Default
- —
- Allowed
6 values
"solid""dashed""dotted""groove""ridge""double"- Runtime
- node22, node24, node26
canvasBuffer.canvas.stroke.width
OptionalPublished canvasBuffer.canvas.stroke.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.transparentBase option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
canvasBuffer.canvas.videoBg
OptionalPublished canvasBuffer.canvas.videoBg option.
- Type
CanvasVideoBackground- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Placement used by `contain` / `cover` when `inherit` is false.
- Type
AlignMode- Default
- —
- Allowed
9 values
"center""top""bottom""left""right""top-left""top-right""bottom-left""bottom-right"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.autoplay option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Image filters applied to this background only.
- Type
ImageFilter[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.levels option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.type option.
- Type
"saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize"- Default
- Required
- Allowed
17 values
"saturation""gaussianBlur""motionBlur""radialBlur""sharpen""noise""grain""edgeDetection""emboss""invert""grayscale""sepia""pixelate""brightness""contrast""hueShift""posterize"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.value option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Optional pixelate region. Omit for the whole filtered surface.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.y option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.videoBg.fit
OptionalResize policy when `inherit` is false.
- Type
FitMode- Default
- —
- Allowed
"fill""contain""cover"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.format option.
- Type
"jpg" | "png"- Default
- —
- Allowed
"jpg""png"- Runtime
- node22, node24, node26
1-based frame number. Mutually exclusive with `time`. Defaults to frame 1 when neither selector is provided.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Adopt the source image dimensions as the canvas dimensions.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
canvasBuffer.canvas.videoBg.loop
OptionalPublished canvasBuffer.canvas.videoBg.loop option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Background-image opacity, multiplied by the canvas-level opacity.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
FFmpeg image quality value from 1 (best) through 31.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.source option.
- Type
string | Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.videoBg.time
OptionalTimestamp in seconds. Mutually exclusive with `frame`.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.width
OptionalPublished canvasBuffer.canvas.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.x
OptionalPublished canvasBuffer.canvas.x option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.y
OptionalPublished canvasBuffer.canvas.y option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.zoom
OptionalPublished canvasBuffer.canvas.zoom option.
- Type
{ scale?: number; centerX?: number; centerY?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.zoom.centerX
OptionalPublished canvasBuffer.canvas.zoom.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.zoom.centerY
OptionalPublished canvasBuffer.canvas.zoom.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.zoom.scale
OptionalPublished canvasBuffer.canvas.zoom.scale option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.groupTransform
OptionalTransform/effect configuration applied to a grouped image set.
- Type
GroupTransformOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.groupTransform.blendMode
OptionalPublished options.groupTransform.blendMode option.
- Type
GlobalCompositeOperation- Default
- —
- Allowed
26 values
"color""color-burn""color-dodge""copy""darken""destination-atop""destination-in""destination-out""destination-over""difference""exclusion""hard-light""hue""lighten""lighter""luminosity""multiply""overlay""saturation""screen""soft-light""source-atop""source-in""source-out""source-over""xor"- Runtime
- node22, node24, node26
options.groupTransform.blur
OptionalPublished options.groupTransform.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.boxBackground option.
- Type
BoxBackground- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.boxBackground.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.boxBackground.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.boxBackground.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.boxBackground.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.boxBackground.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.boxBackground.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.boxBackground.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.boxBackground.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.boxBackground.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.boxBackground.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published options.groupTransform.boxBackground.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.boxBackground.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.boxBackground.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.boxBackground.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published options.groupTransform.boxBackground.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.boxBackground.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.boxBackground.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.boxBackground.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.boxBackground.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.groupTransform.clipPath
OptionalPublished options.groupTransform.clipPath option.
- Type
{ x: number; y: number; }[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.clipPath.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.clipPath.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.distortion option.
- Type
{ type: "perspective" | "warp" | "bulge" | "pinch"; points?: { x: number; y: number; }[]; intensity?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.distortion.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.distortion.points option.
- Type
{ x: number; y: number; }[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.distortion.points.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.distortion.points.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.distortion.type option.
- Type
"perspective" | "warp" | "bulge" | "pinch"- Default
- Required
- Allowed
"perspective""warp""bulge""pinch"- Runtime
- node22, node24, node26
options.groupTransform.effects
OptionalPublished options.groupTransform.effects option.
- Type
{ vignette?: { intensity: number; size: number; }; lensFlare?: { x: number; y: number; intensity: number; }; chromaticAberration?: { intensity: number; }; filmGrain?: { intensity: number; }; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.effects.chromaticAberration option.
- Type
{ intensity: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.effects.chromaticAberration.intensity option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.effects.filmGrain option.
- Type
{ intensity: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.effects.filmGrain.intensity option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.effects.lensFlare option.
- Type
{ x: number; y: number; intensity: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.effects.lensFlare.intensity option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.effects.lensFlare.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.effects.lensFlare.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.effects.vignette option.
- Type
{ intensity: number; size: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.effects.vignette.intensity option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.effects.vignette.size option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.filterIntensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.filterOrder option.
- Type
"pre" | "post"- Default
- —
- Allowed
"pre""post"- Runtime
- node22, node24, node26
options.groupTransform.filters
OptionalPublished options.groupTransform.filters option.
- Type
ImageFilter[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.filters.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.filters.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.filters.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.filters.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.filters.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.filters.levels option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.filters.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.filters.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.filters.type option.
- Type
"saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize"- Default
- Required
- Allowed
17 values
"saturation""gaussianBlur""motionBlur""radialBlur""sharpen""noise""grain""edgeDetection""emboss""invert""grayscale""sepia""pixelate""brightness""contrast""hueShift""posterize"- Runtime
- node22, node24, node26
Published options.groupTransform.filters.value option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.filters.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.groupTransform.filters.x
OptionalOptional pixelate region. Omit for the whole filtered surface.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.groupTransform.filters.y
OptionalPublished options.groupTransform.filters.y option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.groupTransform.mask
OptionalPublished options.groupTransform.mask option.
- Type
{ source: string | Buffer<ArrayBufferLike>; mode?: "alpha" | "luminance" | "inverse"; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.groupTransform.mask.mode
OptionalPublished options.groupTransform.mask.mode option.
- Type
"alpha" | "luminance" | "inverse"- Default
- —
- Allowed
"alpha""luminance""inverse"- Runtime
- node22, node24, node26
Published options.groupTransform.mask.source option.
- Type
string | Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
options.groupTransform.meshWarp
OptionalPublished options.groupTransform.meshWarp option.
- Type
{ gridX?: number; gridY?: number; controlPoints?: { x: number; y: number; }[][]; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.meshWarp.controlPoints option.
- Type
{ x: number; y: number; }[][]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.meshWarp.controlPoints.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.meshWarp.controlPoints.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.meshWarp.gridX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.meshWarp.gridY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.groupTransform.opacity
OptionalPublished options.groupTransform.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.groupTransform.pivotX
OptionalPublished options.groupTransform.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.groupTransform.pivotY
OptionalPublished options.groupTransform.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.groupTransform.rotation
OptionalPublished options.groupTransform.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.groupTransform.scaleX
OptionalPublished options.groupTransform.scaleX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.groupTransform.scaleY
OptionalPublished options.groupTransform.scaleY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.groupTransform.shadow
OptionalPublished options.groupTransform.shadow option.
- Type
ShadowOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.shadow.roundedCorners option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.groupTransform.stroke
OptionalPublished options.groupTransform.stroke option.
- Type
StrokeOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.position option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.roundedCorners option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.style option.
- Type
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"- Default
- —
- Allowed
6 values
"solid""dashed""dotted""groove""ridge""double"- Runtime
- node22, node24, node26
Published options.groupTransform.stroke.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.translateX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published options.groupTransform.translateY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.isGrouped
OptionalTreat multiple image layers as a transformable group.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
painterOpts.resolveAssetRefs
OptionalResolve named Apexify asset references before rendering.
- Type
boolean- Default
false- Allowed
falsetrue- Runtime
- node22, node24, node26
Types
ImageProperties | ImageProperties[]
- variant 1
ImageProperties: ImageProperties- source
string | Buffer<ArrayBufferLike>- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- x
number - y
number - width?
number - height?
number - inherit?
boolean - fit?
FitMode- variant 1
"fill" - variant 2
"contain" - variant 3
"cover"
- variant 1
- align?
AlignMode- variant 1
"center" - variant 2
"top" - variant 3
"bottom" - variant 4
"left" - variant 5
"right" - variant 6
"top-left" - variant 7
"top-right" - variant 8
"bottom-left" - variant 9
"bottom-right"
- variant 1
- rotation?
number - opacity?
number - blur?
number - blendMode?
GlobalCompositeOperation- variant 1
"color" - variant 2
"color-burn" - variant 3
"color-dodge" - variant 4
"copy" - variant 5
"darken" - variant 6
"destination-atop" - variant 7
"destination-in" - variant 8
"destination-out" - variant 9
"destination-over" - variant 10
"difference" - variant 11
"exclusion" - variant 12
"hard-light" - variant 13
"hue" - variant 14
"lighten" - variant 15
"lighter" - variant 16
"luminosity" - variant 17
"multiply" - variant 18
"overlay" - variant 19
"saturation" - variant 20
"screen" - variant 21
"soft-light" - variant 22
"source-atop" - variant 23
"source-in" - variant 24
"source-out" - variant 25
"source-over" - variant 26
"xor"
- variant 1
- borderRadius?
number | "circular"- variant 1
number - variant 2
"circular"
- variant 1
- borderPosition?
string - filters?
ImageFilter[]- variant 1
ImageFilter: ImageFilter- type
"saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize"- variant 1
"saturation" - variant 2
"gaussianBlur" - variant 3
"motionBlur" - variant 4
"radialBlur" - variant 5
"sharpen" - variant 6
"noise" - variant 7
"grain" - variant 8
"edgeDetection" - variant 9
"emboss" - variant 10
"invert" - variant 11
"grayscale" - variant 12
"sepia" - variant 13
"pixelate" - variant 14
"brightness" - variant 15
"contrast" - variant 16
"hueShift" - variant 17
"posterize"
- variant 1
- intensity?
number - radius?
number - angle?
number - centerX?
number - centerY?
number - value?
number - levels?
number - size?
number - x?
number - y?
number - width?
number - height?
number
- type
- variant 1
- filterIntensity?
number - filterOrder?
"pre" | "post"- variant 1
"pre" - variant 2
"post"
- variant 1
- mask?
__type: { source: string | Buffer<ArrayBufferLike>; mode?: "alpha" | "luminance" | "inverse"; }- source
string | Buffer<ArrayBufferLike>- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- mode?
"alpha" | "luminance" | "inverse"- variant 1
"alpha" - variant 2
"luminance" - variant 3
"inverse"
- variant 1
- source
- clipPath?
{ x: number; y: number; }[]- variant 1
__type: { x: number; y: number; }- x
number - y
number
- x
- variant 1
- distortion?
__type: { type: "perspective" | "warp" | "bulge" | "pinch"; points?: { x: number; y: number; }[]; intensity?: number; }- type
"perspective" | "warp" | "bulge" | "pinch"- variant 1
"perspective" - variant 2
"warp" - variant 3
"bulge" - variant 4
"pinch"
- variant 1
- points?
{ x: number; y: number; }[]- variant 1
__type: { x: number; y: number; }- x
number - y
number
- x
- variant 1
- intensity?
number
- type
- meshWarp?
__type: { gridX?: number; gridY?: number; controlPoints?: { x: number; y: number; }[][]; }- gridX?
number - gridY?
number - controlPoints?
{ x: number; y: number; }[][]- variant 1
{ x: number; y: number; }[]- variant 1
{ x: number; y: number; }
- variant 1
- variant 1
- gridX?
- effects?
__type: { vignette?: { intensity: number; size: number; }; lensFlare?: { x: number; y: number; intensity: number; }; chromaticAberration?: { intensity: number; }; filmGrain?: { intensity: number; }; }- vignette?
__type: { intensity: number; size: number; }- intensity
number - size
number
- intensity
- lensFlare?
__type: { x: number; y: number; intensity: number; }- x
number - y
number - intensity
number
- x
- chromaticAberration?
__type: { intensity: number; }- intensity
number
- intensity
- filmGrain?
__type: { intensity: number; }- intensity
number
- intensity
- vignette?
- shape?
ShapeProperties: ShapeProperties- fill?
boolean - color?
string - gradient?
gradient- variant 1
__type: { type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"linear" - startX?
number - startY?
number - endX?
number - endY?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 2
__type: { type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"radial" - startX?
number - startY?
number - startRadius?
number - endX?
number - endY?
number - endRadius?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 3
__type: { type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }- type
"conic" - centerX?
number - centerY?
number - startAngle?
number - rotate?
number - pivotX?
number - pivotY?
number - colors
GradientStop[]
- type
- variant 1
- points?
{ x: number; y: number; }[]- variant 1
__type: { x: number; y: number; }- x
number - y
number
- x
- variant 1
- radius?
number - sides?
number - innerRadius?
number - outerRadius?
number - startAngle?
number - endAngle?
number - centerX?
number - centerY?
number
- fill?
- shadow?
ShadowOptions: ShadowOptions- color?
string - gradient?
gradient- variant 1
__type: { type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"linear" - startX?
number - startY?
number - endX?
number - endY?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 2
__type: { type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"radial" - startX?
number - startY?
number - startRadius?
number - endX?
number - endY?
number - endRadius?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 3
__type: { type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }- type
"conic" - centerX?
number - centerY?
number - startAngle?
number - rotate?
number - pivotX?
number - pivotY?
number - colors
GradientStop[]
- type
- variant 1
- offsetX?
number - offsetY?
number - blur?
number - opacity?
number - borderRadius?
number | "circular"- variant 1
number - variant 2
"circular"
- variant 1
- roundedCorners?
string - borderPosition?
string
- color?
- stroke?
StrokeOptions: StrokeOptions- color?
string - gradient?
gradient- variant 1
__type: { type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"linear" - startX?
number - startY?
number - endX?
number - endY?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 2
__type: { type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"radial" - startX?
number - startY?
number - startRadius?
number - endX?
number - endY?
number - endRadius?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 3
__type: { type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }- type
"conic" - centerX?
number - centerY?
number - startAngle?
number - rotate?
number - pivotX?
number - pivotY?
number - colors
GradientStop[]
- type
- variant 1
- width?
number - position?
number - blur?
number - opacity?
number - borderRadius?
number | "circular"- variant 1
number - variant 2
"circular"
- variant 1
- borderPosition?
string - roundedCorners?
string - style?
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"- variant 1
"solid" - variant 2
"dashed" - variant 3
"dotted" - variant 4
"groove" - variant 5
"ridge" - variant 6
"double"
- variant 1
- color?
- boxBackground?
BoxBackground: BoxBackground- color?
string - gradient?
gradient- variant 1
__type: { type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"linear" - startX?
number - startY?
number - endX?
number - endY?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 2
__type: { type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"radial" - startX?
number - startY?
number - startRadius?
number - endX?
number - endY?
number - endRadius?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 3
__type: { type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }- type
"conic" - centerX?
number - centerY?
number - startAngle?
number - rotate?
number - pivotX?
number - pivotY?
number - colors
GradientStop[]
- type
- variant 1
- color?
- source
- variant 2
ImageProperties[]- variant 1
ImageProperties: ImageProperties- source
string | Buffer<ArrayBufferLike>- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- x
number - y
number - width?
number - height?
number - inherit?
boolean - fit?
FitMode- variant 1
"fill" - variant 2
"contain" - variant 3
"cover"
- variant 1
- align?
AlignMode- variant 1
"center" - variant 2
"top" - variant 3
"bottom" - variant 4
"left" - variant 5
"right" - variant 6
"top-left" - variant 7
"top-right" - variant 8
"bottom-left" - variant 9
"bottom-right"
- variant 1
- rotation?
number - opacity?
number - blur?
number - blendMode?
GlobalCompositeOperation- variant 1
"color" - variant 2
"color-burn" - variant 3
"color-dodge" - variant 4
"copy" - variant 5
"darken" - variant 6
"destination-atop" - variant 7
"destination-in" - variant 8
"destination-out" - variant 9
"destination-over" - variant 10
"difference" - variant 11
"exclusion" - variant 12
"hard-light" - variant 13
"hue" - variant 14
"lighten" - variant 15
"lighter" - variant 16
"luminosity" - variant 17
"multiply" - variant 18
"overlay" - variant 19
"saturation" - variant 20
"screen" - variant 21
"soft-light" - variant 22
"source-atop" - variant 23
"source-in" - variant 24
"source-out" - variant 25
"source-over" - variant 26
"xor"
- variant 1
- borderRadius?
number | "circular"- variant 1
number - variant 2
"circular"
- variant 1
- borderPosition?
string - filters?
ImageFilter[]- variant 1
ImageFilter: ImageFilter- type
"saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize" - intensity?
number - radius?
number - angle?
number - centerX?
number - centerY?
number - value?
number - levels?
number - size?
number - x?
number - y?
number - width?
number - height?
number
- type
- variant 1
- filterIntensity?
number - filterOrder?
"pre" | "post"- variant 1
"pre" - variant 2
"post"
- variant 1
- mask?
__type: { source: string | Buffer<ArrayBufferLike>; mode?: "alpha" | "luminance" | "inverse"; }- source
string | Buffer<ArrayBufferLike>- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- mode?
"alpha" | "luminance" | "inverse"- variant 1
"alpha" - variant 2
"luminance" - variant 3
"inverse"
- variant 1
- source
- clipPath?
{ x: number; y: number; }[]- variant 1
__type: { x: number; y: number; }- x
number - y
number
- x
- variant 1
- distortion?
__type: { type: "perspective" | "warp" | "bulge" | "pinch"; points?: { x: number; y: number; }[]; intensity?: number; }- type
"perspective" | "warp" | "bulge" | "pinch"- variant 1
"perspective" - variant 2
"warp" - variant 3
"bulge" - variant 4
"pinch"
- variant 1
- points?
{ x: number; y: number; }[]- variant 1
{ x: number; y: number; }
- variant 1
- intensity?
number
- type
- meshWarp?
__type: { gridX?: number; gridY?: number; controlPoints?: { x: number; y: number; }[][]; }- gridX?
number - gridY?
number - controlPoints?
{ x: number; y: number; }[][]- variant 1
{ x: number; y: number; }[]
- variant 1
- gridX?
- effects?
__type: { vignette?: { intensity: number; size: number; }; lensFlare?: { x: number; y: number; intensity: number; }; chromaticAberration?: { intensity: number; }; filmGrain?: { intensity: number; }; }- vignette?
__type: { intensity: number; size: number; }- intensity
number - size
number
- intensity
- lensFlare?
__type: { x: number; y: number; intensity: number; }- x
number - y
number - intensity
number
- x
- chromaticAberration?
__type: { intensity: number; }- intensity
number
- intensity
- filmGrain?
__type: { intensity: number; }- intensity
number
- intensity
- vignette?
- shape?
ShapeProperties: ShapeProperties- fill?
boolean - color?
string - gradient?
gradient- variant 1
{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 2
{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 3
{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
- variant 1
- points?
{ x: number; y: number; }[]- variant 1
{ x: number; y: number; }
- variant 1
- radius?
number - sides?
number - innerRadius?
number - outerRadius?
number - startAngle?
number - endAngle?
number - centerX?
number - centerY?
number
- fill?
- shadow?
ShadowOptions: ShadowOptions- color?
string - gradient?
gradient- variant 1
{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 2
{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 3
{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
- variant 1
- offsetX?
number - offsetY?
number - blur?
number - opacity?
number - borderRadius?
number | "circular"- variant 1
number - variant 2
"circular"
- variant 1
- roundedCorners?
string - borderPosition?
string
- color?
- stroke?
StrokeOptions: StrokeOptions- color?
string - gradient?
gradient- variant 1
{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 2
{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 3
{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
- variant 1
- width?
number - position?
number - blur?
number - opacity?
number - borderRadius?
number | "circular"- variant 1
number - variant 2
"circular"
- variant 1
- borderPosition?
string - roundedCorners?
string - style?
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"- variant 1
"solid" - variant 2
"dashed" - variant 3
"dotted" - variant 4
"groove" - variant 5
"ridge" - variant 6
"double"
- variant 1
- color?
- boxBackground?
BoxBackground: BoxBackground- color?
string - gradient?
gradient- variant 1
{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 2
{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 3
{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
- variant 1
- color?
- source
- variant 1
Buffer<ArrayBufferLike> | CanvasResults
- variant 1
Buffer<ArrayBufferLike> - variant 2
CanvasResults: CanvasResults- buffer
Buffer<ArrayBufferLike> - canvas
CanvasConfig: CanvasConfig- width?
number - height?
number - x?
number - y?
number - customBg?
CanvasCustomBackground: CanvasCustomBackground- source
string - inherit?
boolean - fit?
FitMode- variant 1
"fill" - variant 2
"contain" - variant 3
"cover"
- variant 1
- align?
AlignMode- variant 1
"center" - variant 2
"top" - variant 3
"bottom" - variant 4
"left" - variant 5
"right" - variant 6
"top-left" - variant 7
"top-right" - variant 8
"bottom-left" - variant 9
"bottom-right"
- variant 1
- filters?
ImageFilter[]- variant 1
ImageFilter
- variant 1
- opacity?
number
- source
- videoBg?
CanvasVideoBackground: CanvasVideoBackground- source
string | Buffer<ArrayBufferLike>- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- frame?
number - time?
number - format?
"jpg" | "png"- variant 1
"jpg" - variant 2
"png"
- variant 1
- quality?
number - loop?
boolean - autoplay?
boolean - inherit?
boolean - fit?
FitMode- variant 1
"fill" - variant 2
"contain" - variant 3
"cover"
- variant 1
- align?
AlignMode- variant 1
"center" - variant 2
"top" - variant 3
"bottom" - variant 4
"left" - variant 5
"right" - variant 6
"top-left" - variant 7
"top-right" - variant 8
"bottom-left" - variant 9
"bottom-right"
- variant 1
- filters?
ImageFilter[]- variant 1
ImageFilter
- variant 1
- opacity?
number
- source
- colorBg?
string - gradientBg?
gradient- variant 1
__type: { type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"linear" - startX?
number - startY?
number - endX?
number - endY?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 2
__type: { type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"radial" - startX?
number - startY?
number - startRadius?
number - endX?
number - endY?
number - endRadius?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 3
__type: { type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }- type
"conic" - centerX?
number - centerY?
number - startAngle?
number - rotate?
number - pivotX?
number - pivotY?
number - colors
GradientStop[]
- type
- variant 1
- patternBg?
PatternOptions: PatternOptions- type
"grid" | "dots" | "diagonal" | "stripes" | "waves" | "crosses" | "hexagons" | "checkerboard" | "diamonds" | "triangles" | "stars" | "polka" | "custom"- variant 1
"grid" - variant 2
"dots" - variant 3
"diagonal" - variant 4
"stripes" - variant 5
"waves" - variant 6
"crosses" - variant 7
"hexagons" - variant 8
"checkerboard" - variant 9
"diamonds" - variant 10
"triangles" - variant 11
"stars" - variant 12
"polka" - variant 13
"custom"
- variant 1
- color?
string - secondaryColor?
string - opacity?
number - size?
number - spacing?
number - rotation?
number - customPatternImage?
string - repeat?
"repeat" | "no-repeat" | "repeat-x" | "repeat-y"- variant 1
"repeat" - variant 2
"no-repeat" - variant 3
"repeat-x" - variant 4
"repeat-y"
- variant 1
- scale?
number - offsetX?
number - offsetY?
number - blendMode?
GlobalCompositeOperation- variant 1
"color" - variant 2
"color-burn" - variant 3
"color-dodge" - variant 4
"copy" - variant 5
"darken" - variant 6
"destination-atop" - variant 7
"destination-in" - variant 8
"destination-out" - variant 9
"destination-over" - variant 10
"difference" - variant 11
"exclusion" - variant 12
"hard-light" - variant 13
"hue" - variant 14
"lighten" - variant 15
"lighter" - variant 16
"luminosity" - variant 17
"multiply" - variant 18
"overlay" - variant 19
"saturation" - variant 20
"screen" - variant 21
"soft-light" - variant 22
"source-atop" - variant 23
"source-in" - variant 24
"source-out" - variant 25
"source-over" - variant 26
"xor"
- variant 1
- gradient?
GradientConfig: GradientConfig- type
"linear" | "radial" | "conic" - startX?
number - startY?
number - endX?
number - endY?
number - startRadius?
number - endRadius?
number - angle?
number - centerX?
number - centerY?
number - startAngle?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
{ stop: number; color: string; }[]
- type
- type
- noiseBg?
__type: { intensity?: number; }- intensity?
number
- intensity?
- transparentBase?
boolean - bgLayers?
BackgroundLayer[]- variant 1
BackgroundLayer- variant 1
{ type: "color"; value: string; opacity?: number; blendMode?: GlobalCompositeOperation; } - variant 2
{ type: "gradient"; value: gradient; opacity?: number; blendMode?: GlobalCompositeOperation; } - variant 3
{ type: "image"; source: string; opacity?: number; fit?: "fill" | "contain" | "cover"; align?: AlignMode; blendMode?: GlobalCompositeOperation; } - variant 4
{ type: "pattern"; source: string; repeat?: BackgroundPatternRepeat; opacity?: number; blendMode?: GlobalCompositeOperation; } - variant 5
{ type: "presetPattern"; pattern: PatternOptions; opacity?: number; blendMode?: GlobalCompositeOperation; } - variant 6
{ type: "noise"; intensity?: number; blendMode?: GlobalCompositeOperation; }
- variant 1
- variant 1
- blendMode?
GlobalCompositeOperation- variant 1
"color" - variant 2
"color-burn" - variant 3
"color-dodge" - variant 4
"copy" - variant 5
"darken" - variant 6
"destination-atop" - variant 7
"destination-in" - variant 8
"destination-out" - variant 9
"destination-over" - variant 10
"difference" - variant 11
"exclusion" - variant 12
"hard-light" - variant 13
"hue" - variant 14
"lighten" - variant 15
"lighter" - variant 16
"luminosity" - variant 17
"multiply" - variant 18
"overlay" - variant 19
"saturation" - variant 20
"screen" - variant 21
"soft-light" - variant 22
"source-atop" - variant 23
"source-in" - variant 24
"source-out" - variant 25
"source-over" - variant 26
"xor"
- variant 1
- opacity?
number - blur?
number - rotation?
number - borderRadius?
number | "circular"- variant 1
number - variant 2
"circular"
- variant 1
- borderPosition?
string - zoom?
__type: { scale?: number; centerX?: number; centerY?: number; }- scale?
number - centerX?
number - centerY?
number
- scale?
- stroke?
StrokeOptions: StrokeOptions- color?
string - gradient?
gradient- variant 1
{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 2
{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 3
{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
- variant 1
- width?
number - position?
number - blur?
number - opacity?
number - borderRadius?
number | "circular"- variant 1
number - variant 2
"circular"
- variant 1
- borderPosition?
string - roundedCorners?
string - style?
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"- variant 1
"solid" - variant 2
"dashed" - variant 3
"dotted" - variant 4
"groove" - variant 5
"ridge" - variant 6
"double"
- variant 1
- color?
- shadow?
ShadowOptions: ShadowOptions- color?
string - gradient?
gradient- variant 1
{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 2
{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 3
{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
- variant 1
- offsetX?
number - offsetY?
number - blur?
number - opacity?
number - borderRadius?
number | "circular"- variant 1
number - variant 2
"circular"
- variant 1
- roundedCorners?
string - borderPosition?
string
- color?
- width?
- buffer
CreateImageOptions: CreateImageOptions
- isGrouped?
boolean - groupTransform?
GroupTransformOptions: GroupTransformOptions- rotation?
number - translateX?
number - translateY?
number - scaleX?
number - scaleY?
number - pivotX?
number - pivotY?
number - opacity?
number - blur?
number - blendMode?
GlobalCompositeOperation- variant 1
"color" - variant 2
"color-burn" - variant 3
"color-dodge" - variant 4
"copy" - variant 5
"darken" - variant 6
"destination-atop" - variant 7
"destination-in" - variant 8
"destination-out" - variant 9
"destination-over" - variant 10
"difference" - variant 11
"exclusion" - variant 12
"hard-light" - variant 13
"hue" - variant 14
"lighten" - variant 15
"lighter" - variant 16
"luminosity" - variant 17
"multiply" - variant 18
"overlay" - variant 19
"saturation" - variant 20
"screen" - variant 21
"soft-light" - variant 22
"source-atop" - variant 23
"source-in" - variant 24
"source-out" - variant 25
"source-over" - variant 26
"xor"
- variant 1
- borderRadius?
number | "circular"- variant 1
number - variant 2
"circular"
- variant 1
- borderPosition?
string - filters?
ImageFilter[]- variant 1
ImageFilter: ImageFilter- type
"saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize"- variant 1
"saturation" - variant 2
"gaussianBlur" - variant 3
"motionBlur" - variant 4
"radialBlur" - variant 5
"sharpen" - variant 6
"noise" - variant 7
"grain" - variant 8
"edgeDetection" - variant 9
"emboss" - variant 10
"invert" - variant 11
"grayscale" - variant 12
"sepia" - variant 13
"pixelate" - variant 14
"brightness" - variant 15
"contrast" - variant 16
"hueShift" - variant 17
"posterize"
- variant 1
- intensity?
number - radius?
number - angle?
number - centerX?
number - centerY?
number - value?
number - levels?
number - size?
number - x?
number - y?
number - width?
number - height?
number
- type
- variant 1
- filterIntensity?
number - filterOrder?
"pre" | "post"- variant 1
"pre" - variant 2
"post"
- variant 1
- mask?
__type: { source: string | Buffer<ArrayBufferLike>; mode?: "alpha" | "luminance" | "inverse"; }- source
string | Buffer<ArrayBufferLike>- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- mode?
"alpha" | "luminance" | "inverse"- variant 1
"alpha" - variant 2
"luminance" - variant 3
"inverse"
- variant 1
- source
- clipPath?
{ x: number; y: number; }[]- variant 1
__type: { x: number; y: number; }- x
number - y
number
- x
- variant 1
- distortion?
__type: { type: "perspective" | "warp" | "bulge" | "pinch"; points?: { x: number; y: number; }[]; intensity?: number; }- type
"perspective" | "warp" | "bulge" | "pinch"- variant 1
"perspective" - variant 2
"warp" - variant 3
"bulge" - variant 4
"pinch"
- variant 1
- points?
{ x: number; y: number; }[]- variant 1
__type: { x: number; y: number; }- x
number - y
number
- x
- variant 1
- intensity?
number
- type
- meshWarp?
__type: { gridX?: number; gridY?: number; controlPoints?: { x: number; y: number; }[][]; }- gridX?
number - gridY?
number - controlPoints?
{ x: number; y: number; }[][]- variant 1
{ x: number; y: number; }[]- variant 1
{ x: number; y: number; }
- variant 1
- variant 1
- gridX?
- effects?
__type: { vignette?: { intensity: number; size: number; }; lensFlare?: { x: number; y: number; intensity: number; }; chromaticAberration?: { intensity: number; }; filmGrain?: { intensity: number; }; }- vignette?
__type: { intensity: number; size: number; }- intensity
number - size
number
- intensity
- lensFlare?
__type: { x: number; y: number; intensity: number; }- x
number - y
number - intensity
number
- x
- chromaticAberration?
__type: { intensity: number; }- intensity
number
- intensity
- filmGrain?
__type: { intensity: number; }- intensity
number
- intensity
- vignette?
- shadow?
ShadowOptions: ShadowOptions- color?
string - gradient?
gradient- variant 1
__type: { type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"linear" - startX?
number - startY?
number - endX?
number - endY?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 2
__type: { type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"radial" - startX?
number - startY?
number - startRadius?
number - endX?
number - endY?
number - endRadius?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 3
__type: { type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }- type
"conic" - centerX?
number - centerY?
number - startAngle?
number - rotate?
number - pivotX?
number - pivotY?
number - colors
GradientStop[]
- type
- variant 1
- offsetX?
number - offsetY?
number - blur?
number - opacity?
number - borderRadius?
number | "circular"- variant 1
number - variant 2
"circular"
- variant 1
- roundedCorners?
string - borderPosition?
string
- color?
- stroke?
StrokeOptions: StrokeOptions- color?
string - gradient?
gradient- variant 1
__type: { type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"linear" - startX?
number - startY?
number - endX?
number - endY?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 2
__type: { type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"radial" - startX?
number - startY?
number - startRadius?
number - endX?
number - endY?
number - endRadius?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 3
__type: { type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }- type
"conic" - centerX?
number - centerY?
number - startAngle?
number - rotate?
number - pivotX?
number - pivotY?
number - colors
GradientStop[]
- type
- variant 1
- width?
number - position?
number - blur?
number - opacity?
number - borderRadius?
number | "circular"- variant 1
number - variant 2
"circular"
- variant 1
- borderPosition?
string - roundedCorners?
string - style?
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"- variant 1
"solid" - variant 2
"dashed" - variant 3
"dotted" - variant 4
"groove" - variant 5
"ridge" - variant 6
"double"
- variant 1
- color?
- boxBackground?
BoxBackground: BoxBackground- color?
string - gradient?
gradient- variant 1
__type: { type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"linear" - startX?
number - startY?
number - endX?
number - endY?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 2
__type: { type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"radial" - startX?
number - startY?
number - startRadius?
number - endX?
number - endY?
number - endRadius?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 3
__type: { type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }- type
"conic" - centerX?
number - centerY?
number - startAngle?
number - rotate?
number - pivotX?
number - pivotY?
number - colors
GradientStop[]
- type
- variant 1
- color?
- rotation?
PainterAssetRefsOptions: PainterAssetRefsOptions
- resolveAssetRefs?
boolean
Return value
Promise<Buffer<ArrayBufferLike>>
The return contract is generated from the packed declaration. Async wrappers and nullable/undefined variants remain visible in the type model.
Errors
ApexifyInputError
- Condition
- Required source/x/y data is absent, the image list is empty, or validated image options are invalid.
- Resolution
- Provide the required fields and values accepted by the published declaration/validators.
- Runtime
- node22, node24, node26
- Recoverability
- Correct input and retry.
ApexifyDecodeError
- Condition
- A supplied image source cannot be decoded as supported image data.
- Resolution
- Use a supported, decodable image source within configured limits.
- Runtime
- node22, node24, node26
- Recoverability
- Replace/fix source and retry.
ApexifyResourceLimitError
- Condition
- Image dimensions, source bytes, decoded pixels/frames, filters, or collection work exceed active RenderLimits.
- Resolution
- Reduce the workload or explicitly configure safe process-wide RenderLimits.
- Runtime
- node22, node24, node26
- Recoverability
- Reduce input or adjust policy, then retry.
Limits
maxCanvasDimension
16384 px — Bounds configured image width/height and decoded image dimensions.
Source:lib-next/runtime/config.ts (opens in a new tab)maxCollectionItems
2048 items — Bounds image/shape collection work.
Source:lib-next/runtime/config.ts (opens in a new tab)maxFiltersPerOperation
64 filters — Bounds filters applied in one image operation.
Source:lib-next/runtime/config.ts (opens in a new tab)maxImageSourceBytes
67108864 bytes — Bounds accepted image source bytes.
Source:lib-next/runtime/config.ts (opens in a new tab)maxDecodedImagePixels
67108864 pixels — Bounds decoded image pixel count.
Source:lib-next/runtime/config.ts (opens in a new tab)maxDecodedImageFrames
128 frames — Bounds decoded image frame count.
Source:lib-next/runtime/config.ts (opens in a new tab)