Skip to content
Apexify.jsDocs
Apexify.js version v5.4.5

ApexPainter member

ApexPainter.createCanvas

Published ApexPainter.createCanvas method.

apexify.jsCURRENTnode22node24node26
Source: lib-next/apex-painter/main.ts (opens in a new tab)

Signature

TypeScript
(canvas: CanvasConfig, painterOpts?: PainterAssetRefsOptions) => Promise<CanvasResults>

Parameters

Options

208 / 208 option paths
OptionTypeContractAllowed valuesRuntime & capabilities
canvas
canvas.bgLayersPublished canvas.bgLayers option.BackgroundLayer[]OptionalDefault——node22 · node24 · node26
canvas.bgLayers.blendModePublished canvas.bgLayers.blendMode option.GlobalCompositeOperationOptionalDefault—
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
canvas.bgLayers.opacityPublished canvas.bgLayers.opacity option.numberOptionalDefault——node22 · node24 · node26
canvas.bgLayers.typePublished canvas.bgLayers.type option."color"RequiredDefaultRequired"color"node22 · node24 · node26
canvas.bgLayers.valuePublished canvas.bgLayers.value option.stringRequiredDefaultRequired—node22 · node24 · node26
canvas.bgLayers.alignPublished canvas.bgLayers.align option.AlignModeOptionalDefault—
9 values
"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right"
node22 · node24 · node26
canvas.bgLayers.fitPublished canvas.bgLayers.fit option."fill" | "contain" | "cover"OptionalDefault—"fill" "contain" "cover"node22 · node24 · node26
canvas.bgLayers.sourcePublished canvas.bgLayers.source option.stringRequiredDefaultRequired—node22 · node24 · node26
canvas.bgLayers.repeatPublished canvas.bgLayers.repeat option.BackgroundPatternRepeatOptionalDefault—"repeat" "no-repeat" "repeat-x" "repeat-y"node22 · node24 · node26
canvas.bgLayers.patternPublished canvas.bgLayers.pattern option.PatternOptionsRequiredDefaultRequired—node22 · node24 · node26
canvas.bgLayers.pattern.blendModePublished canvas.bgLayers.pattern.blendMode option.GlobalCompositeOperationOptionalDefault—
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
canvas.bgLayers.pattern.colorPublished canvas.bgLayers.pattern.color option.stringOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.customPatternImagePublished canvas.bgLayers.pattern.customPatternImage option.stringOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.gradientPublished canvas.bgLayers.pattern.gradient option.GradientConfigOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.gradient.anglePublished canvas.bgLayers.pattern.gradient.angle option.numberOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.gradient.centerXPublished canvas.bgLayers.pattern.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.gradient.centerYPublished canvas.bgLayers.pattern.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.gradient.colorsPublished canvas.bgLayers.pattern.gradient.colors option.{ stop: number; color: string; }[]RequiredDefaultRequired—node22 · node24 · node26
canvas.bgLayers.pattern.gradient.colors.colorPublished canvas.bgLayers.pattern.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
canvas.bgLayers.pattern.gradient.colors.stopPublished canvas.bgLayers.pattern.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
canvas.bgLayers.pattern.gradient.endRadiusPublished canvas.bgLayers.pattern.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.gradient.endXPublished canvas.bgLayers.pattern.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.gradient.endYPublished canvas.bgLayers.pattern.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.gradient.repeatPublished canvas.bgLayers.pattern.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
canvas.bgLayers.pattern.gradient.startAnglePublished canvas.bgLayers.pattern.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.gradient.startRadiusPublished canvas.bgLayers.pattern.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.gradient.startXPublished canvas.bgLayers.pattern.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.gradient.startYPublished canvas.bgLayers.pattern.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.gradient.typePublished canvas.bgLayers.pattern.gradient.type option."linear" | "radial" | "conic"RequiredDefaultRequired"linear" "radial" "conic"node22 · node24 · node26
canvas.bgLayers.pattern.offsetXPublished canvas.bgLayers.pattern.offsetX option.numberOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.offsetYPublished canvas.bgLayers.pattern.offsetY option.numberOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.opacityPublished canvas.bgLayers.pattern.opacity option.numberOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.repeatPublished canvas.bgLayers.pattern.repeat option."repeat" | "no-repeat" | "repeat-x" | "repeat-y"OptionalDefault—"repeat" "no-repeat" "repeat-x" "repeat-y"node22 · node24 · node26
canvas.bgLayers.pattern.rotationPublished canvas.bgLayers.pattern.rotation option.numberOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.scalePublished canvas.bgLayers.pattern.scale option.numberOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.secondaryColorPublished canvas.bgLayers.pattern.secondaryColor option.stringOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.sizePublished canvas.bgLayers.pattern.size option.numberOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.spacingPublished canvas.bgLayers.pattern.spacing option.numberOptionalDefault——node22 · node24 · node26
canvas.bgLayers.pattern.typePublished 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
canvas.bgLayers.intensityPublished canvas.bgLayers.intensity option.numberOptionalDefault——node22 · node24 · node26
canvas.blendModePublished canvas.blendMode option.GlobalCompositeOperationOptionalDefault—
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
canvas.blurPublished canvas.blur option.numberOptionalDefault——node22 · node24 · node26
canvas.borderPositionPublished canvas.borderPosition option.stringOptionalDefault——node22 · node24 · node26
canvas.borderRadiusPublished canvas.borderRadius option.number | "circular"OptionalDefault——node22 · node24 · node26
canvas.colorBgPublished canvas.colorBg option.stringOptionalDefault——node22 · node24 · node26
canvas.customBgPublished canvas.customBg option.CanvasCustomBackgroundOptionalDefault——node22 · node24 · node26
canvas.customBg.alignPlacement used by `contain` / `cover` when `inherit` is false.AlignModeOptionalDefault—
9 values
"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right"
node22 · node24 · node26
canvas.customBg.filtersImage filters applied to this background only.ImageFilter[]OptionalDefault——node22 · node24 · node26
canvas.customBg.filters.anglePublished canvas.customBg.filters.angle option.numberOptionalDefault——node22 · node24 · node26
canvas.customBg.filters.centerXPublished canvas.customBg.filters.centerX option.numberOptionalDefault——node22 · node24 · node26
canvas.customBg.filters.centerYPublished canvas.customBg.filters.centerY option.numberOptionalDefault——node22 · node24 · node26
canvas.customBg.filters.heightPublished canvas.customBg.filters.height option.numberOptionalDefault——node22 · node24 · node26
canvas.customBg.filters.intensityPublished canvas.customBg.filters.intensity option.numberOptionalDefault——node22 · node24 · node26
canvas.customBg.filters.levelsPublished canvas.customBg.filters.levels option.numberOptionalDefault——node22 · node24 · node26
canvas.customBg.filters.radiusPublished canvas.customBg.filters.radius option.numberOptionalDefault——node22 · node24 · node26
canvas.customBg.filters.sizePublished canvas.customBg.filters.size option.numberOptionalDefault——node22 · node24 · node26
canvas.customBg.filters.typePublished 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
canvas.customBg.filters.valuePublished canvas.customBg.filters.value option.numberOptionalDefault——node22 · node24 · node26
canvas.customBg.filters.widthPublished canvas.customBg.filters.width option.numberOptionalDefault——node22 · node24 · node26
canvas.customBg.filters.xOptional pixelate region. Omit for the whole filtered surface.numberOptionalDefault——node22 · node24 · node26
canvas.customBg.filters.yPublished canvas.customBg.filters.y option.numberOptionalDefault——node22 · node24 · node26
canvas.customBg.fitResize policy when `inherit` is false.FitModeOptionalDefault—"fill" "contain" "cover"node22 · node24 · node26
canvas.customBg.inheritAdopt the source image dimensions as the canvas dimensions.booleanOptionalDefault—false truenode22 · node24 · node26
canvas.customBg.opacityBackground-image opacity, multiplied by the canvas-level opacity.numberOptionalDefault——node22 · node24 · node26
canvas.customBg.sourcePublished canvas.customBg.source option.stringRequiredDefaultRequired—node22 · node24 · node26
canvas.gradientBgPublished canvas.gradientBg option.gradientOptionalDefault——node22 · node24 · node26
canvas.gradientBg.colorsPublished canvas.gradientBg.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
canvas.gradientBg.colors.colorPublished canvas.gradientBg.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
canvas.gradientBg.colors.stopPublished canvas.gradientBg.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
canvas.gradientBg.endXPublished canvas.gradientBg.endX option.numberOptionalDefault——node22 · node24 · node26
canvas.gradientBg.endYPublished canvas.gradientBg.endY option.numberOptionalDefault——node22 · node24 · node26
canvas.gradientBg.pivotXPublished canvas.gradientBg.pivotX option.numberOptionalDefault——node22 · node24 · node26
canvas.gradientBg.pivotYPublished canvas.gradientBg.pivotY option.numberOptionalDefault——node22 · node24 · node26
canvas.gradientBg.repeatPublished canvas.gradientBg.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
canvas.gradientBg.rotatePublished canvas.gradientBg.rotate option.numberOptionalDefault——node22 · node24 · node26
canvas.gradientBg.startXPublished canvas.gradientBg.startX option.numberOptionalDefault——node22 · node24 · node26
canvas.gradientBg.startYPublished canvas.gradientBg.startY option.numberOptionalDefault——node22 · node24 · node26
canvas.gradientBg.typePublished canvas.gradientBg.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
canvas.gradientBg.endRadiusPublished canvas.gradientBg.endRadius option.numberOptionalDefault——node22 · node24 · node26
canvas.gradientBg.startRadiusPublished canvas.gradientBg.startRadius option.numberOptionalDefault——node22 · node24 · node26
canvas.gradientBg.centerXPublished canvas.gradientBg.centerX option.numberOptionalDefault——node22 · node24 · node26
canvas.gradientBg.centerYPublished canvas.gradientBg.centerY option.numberOptionalDefault——node22 · node24 · node26
canvas.gradientBg.startAnglePublished canvas.gradientBg.startAngle option.numberOptionalDefault——node22 · node24 · node26
canvas.heightPublished canvas.height option.numberOptionalDefault——node22 · node24 · node26
canvas.noiseBgPublished canvas.noiseBg option.{ intensity?: number; }OptionalDefault——node22 · node24 · node26
canvas.noiseBg.intensityPublished canvas.noiseBg.intensity option.numberOptionalDefault——node22 · node24 · node26
canvas.opacityPublished canvas.opacity option.numberOptionalDefault——node22 · node24 · node26
canvas.patternBgPublished canvas.patternBg option.PatternOptionsOptionalDefault——node22 · node24 · node26
canvas.patternBg.blendModePublished canvas.patternBg.blendMode option.GlobalCompositeOperationOptionalDefault—
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
canvas.patternBg.colorPublished canvas.patternBg.color option.stringOptionalDefault——node22 · node24 · node26
canvas.patternBg.customPatternImagePublished canvas.patternBg.customPatternImage option.stringOptionalDefault——node22 · node24 · node26
canvas.patternBg.gradientPublished canvas.patternBg.gradient option.GradientConfigOptionalDefault——node22 · node24 · node26
canvas.patternBg.gradient.anglePublished canvas.patternBg.gradient.angle option.numberOptionalDefault——node22 · node24 · node26
canvas.patternBg.gradient.centerXPublished canvas.patternBg.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
canvas.patternBg.gradient.centerYPublished canvas.patternBg.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
canvas.patternBg.gradient.colorsPublished canvas.patternBg.gradient.colors option.{ stop: number; color: string; }[]RequiredDefaultRequired—node22 · node24 · node26
canvas.patternBg.gradient.colors.colorPublished canvas.patternBg.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
canvas.patternBg.gradient.colors.stopPublished canvas.patternBg.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
canvas.patternBg.gradient.endRadiusPublished canvas.patternBg.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
canvas.patternBg.gradient.endXPublished canvas.patternBg.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
canvas.patternBg.gradient.endYPublished canvas.patternBg.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
canvas.patternBg.gradient.repeatPublished canvas.patternBg.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
canvas.patternBg.gradient.startAnglePublished canvas.patternBg.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
canvas.patternBg.gradient.startRadiusPublished canvas.patternBg.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
canvas.patternBg.gradient.startXPublished canvas.patternBg.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
canvas.patternBg.gradient.startYPublished canvas.patternBg.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
canvas.patternBg.gradient.typePublished canvas.patternBg.gradient.type option."linear" | "radial" | "conic"RequiredDefaultRequired"linear" "radial" "conic"node22 · node24 · node26
canvas.patternBg.offsetXPublished canvas.patternBg.offsetX option.numberOptionalDefault——node22 · node24 · node26
canvas.patternBg.offsetYPublished canvas.patternBg.offsetY option.numberOptionalDefault——node22 · node24 · node26
canvas.patternBg.opacityPublished canvas.patternBg.opacity option.numberOptionalDefault——node22 · node24 · node26
canvas.patternBg.repeatPublished canvas.patternBg.repeat option."repeat" | "no-repeat" | "repeat-x" | "repeat-y"OptionalDefault—"repeat" "no-repeat" "repeat-x" "repeat-y"node22 · node24 · node26
canvas.patternBg.rotationPublished canvas.patternBg.rotation option.numberOptionalDefault——node22 · node24 · node26
canvas.patternBg.scalePublished canvas.patternBg.scale option.numberOptionalDefault——node22 · node24 · node26
canvas.patternBg.secondaryColorPublished canvas.patternBg.secondaryColor option.stringOptionalDefault——node22 · node24 · node26
canvas.patternBg.sizePublished canvas.patternBg.size option.numberOptionalDefault——node22 · node24 · node26
canvas.patternBg.spacingPublished canvas.patternBg.spacing option.numberOptionalDefault——node22 · node24 · node26
canvas.patternBg.typePublished 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
canvas.rotationPublished canvas.rotation option.numberOptionalDefault——node22 · node24 · node26
canvas.shadowPublished canvas.shadow option.ShadowOptionsOptionalDefault——node22 · node24 · node26
canvas.shadow.blurPublished canvas.shadow.blur option.numberOptionalDefault——node22 · node24 · node26
canvas.shadow.borderPositionPublished canvas.shadow.borderPosition option.DeprecatedstringOptionalDefault——node22 · node24 · node26
canvas.shadow.borderRadiusPublished canvas.shadow.borderRadius option.number | "circular"OptionalDefault——node22 · node24 · node26
canvas.shadow.colorPublished canvas.shadow.color option.stringOptionalDefault——node22 · node24 · node26
canvas.shadow.gradientPublished canvas.shadow.gradient option.gradientOptionalDefault——node22 · node24 · node26
canvas.shadow.gradient.colorsPublished canvas.shadow.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
canvas.shadow.gradient.colors.colorPublished canvas.shadow.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
canvas.shadow.gradient.colors.stopPublished canvas.shadow.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
canvas.shadow.gradient.endXPublished canvas.shadow.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
canvas.shadow.gradient.endYPublished canvas.shadow.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
canvas.shadow.gradient.pivotXPublished canvas.shadow.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
canvas.shadow.gradient.pivotYPublished canvas.shadow.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
canvas.shadow.gradient.repeatPublished canvas.shadow.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
canvas.shadow.gradient.rotatePublished canvas.shadow.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
canvas.shadow.gradient.startXPublished canvas.shadow.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
canvas.shadow.gradient.startYPublished canvas.shadow.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
canvas.shadow.gradient.typePublished canvas.shadow.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
canvas.shadow.gradient.endRadiusPublished canvas.shadow.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
canvas.shadow.gradient.startRadiusPublished canvas.shadow.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
canvas.shadow.gradient.centerXPublished canvas.shadow.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
canvas.shadow.gradient.centerYPublished canvas.shadow.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
canvas.shadow.gradient.startAnglePublished canvas.shadow.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
canvas.shadow.offsetXPublished canvas.shadow.offsetX option.numberOptionalDefault——node22 · node24 · node26
canvas.shadow.offsetYPublished canvas.shadow.offsetY option.numberOptionalDefault——node22 · node24 · node26
canvas.shadow.opacityPublished canvas.shadow.opacity option.numberOptionalDefault——node22 · node24 · node26
canvas.shadow.roundedCornersPublished canvas.shadow.roundedCorners option.stringOptionalDefault——node22 · node24 · node26
canvas.strokePublished canvas.stroke option.StrokeOptionsOptionalDefault——node22 · node24 · node26
canvas.stroke.blurPublished canvas.stroke.blur option.numberOptionalDefault——node22 · node24 · node26
canvas.stroke.borderPositionPublished canvas.stroke.borderPosition option.stringOptionalDefault——node22 · node24 · node26
canvas.stroke.borderRadiusPublished canvas.stroke.borderRadius option.number | "circular"OptionalDefault——node22 · node24 · node26
canvas.stroke.colorPublished canvas.stroke.color option.stringOptionalDefault——node22 · node24 · node26
canvas.stroke.gradientPublished canvas.stroke.gradient option.gradientOptionalDefault——node22 · node24 · node26
canvas.stroke.gradient.colorsPublished canvas.stroke.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
canvas.stroke.gradient.colors.colorPublished canvas.stroke.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
canvas.stroke.gradient.colors.stopPublished canvas.stroke.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
canvas.stroke.gradient.endXPublished canvas.stroke.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
canvas.stroke.gradient.endYPublished canvas.stroke.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
canvas.stroke.gradient.pivotXPublished canvas.stroke.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
canvas.stroke.gradient.pivotYPublished canvas.stroke.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
canvas.stroke.gradient.repeatPublished canvas.stroke.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
canvas.stroke.gradient.rotatePublished canvas.stroke.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
canvas.stroke.gradient.startXPublished canvas.stroke.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
canvas.stroke.gradient.startYPublished canvas.stroke.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
canvas.stroke.gradient.typePublished canvas.stroke.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
canvas.stroke.gradient.endRadiusPublished canvas.stroke.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
canvas.stroke.gradient.startRadiusPublished canvas.stroke.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
canvas.stroke.gradient.centerXPublished canvas.stroke.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
canvas.stroke.gradient.centerYPublished canvas.stroke.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
canvas.stroke.gradient.startAnglePublished canvas.stroke.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
canvas.stroke.opacityPublished canvas.stroke.opacity option.numberOptionalDefault——node22 · node24 · node26
canvas.stroke.positionPublished canvas.stroke.position option.numberOptionalDefault——node22 · node24 · node26
canvas.stroke.roundedCornersPublished canvas.stroke.roundedCorners option.stringOptionalDefault——node22 · node24 · node26
canvas.stroke.stylePublished canvas.stroke.style option."solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"OptionalDefault—
6 values
"solid" "dashed" "dotted" "groove" "ridge" "double"
node22 · node24 · node26
canvas.stroke.widthPublished canvas.stroke.width option.numberOptionalDefault——node22 · node24 · node26
canvas.transparentBasePublished canvas.transparentBase option.booleanOptionalDefault—false truenode22 · node24 · node26
canvas.videoBgPublished canvas.videoBg option.CanvasVideoBackgroundOptionalDefault——node22 · node24 · node26
canvas.videoBg.alignPlacement used by `contain` / `cover` when `inherit` is false.AlignModeOptionalDefault—
9 values
"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right"
node22 · node24 · node26
canvas.videoBg.autoplayPublished canvas.videoBg.autoplay option.DeprecatedbooleanOptionalDefault—false truenode22 · node24 · node26
canvas.videoBg.filtersImage filters applied to this background only.ImageFilter[]OptionalDefault——node22 · node24 · node26
canvas.videoBg.filters.anglePublished canvas.videoBg.filters.angle option.numberOptionalDefault——node22 · node24 · node26
canvas.videoBg.filters.centerXPublished canvas.videoBg.filters.centerX option.numberOptionalDefault——node22 · node24 · node26
canvas.videoBg.filters.centerYPublished canvas.videoBg.filters.centerY option.numberOptionalDefault——node22 · node24 · node26
canvas.videoBg.filters.heightPublished canvas.videoBg.filters.height option.numberOptionalDefault——node22 · node24 · node26
canvas.videoBg.filters.intensityPublished canvas.videoBg.filters.intensity option.numberOptionalDefault——node22 · node24 · node26
canvas.videoBg.filters.levelsPublished canvas.videoBg.filters.levels option.numberOptionalDefault——node22 · node24 · node26
canvas.videoBg.filters.radiusPublished canvas.videoBg.filters.radius option.numberOptionalDefault——node22 · node24 · node26
canvas.videoBg.filters.sizePublished canvas.videoBg.filters.size option.numberOptionalDefault——node22 · node24 · node26
canvas.videoBg.filters.typePublished 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
canvas.videoBg.filters.valuePublished canvas.videoBg.filters.value option.numberOptionalDefault——node22 · node24 · node26
canvas.videoBg.filters.widthPublished canvas.videoBg.filters.width option.numberOptionalDefault——node22 · node24 · node26
canvas.videoBg.filters.xOptional pixelate region. Omit for the whole filtered surface.numberOptionalDefault——node22 · node24 · node26
canvas.videoBg.filters.yPublished canvas.videoBg.filters.y option.numberOptionalDefault——node22 · node24 · node26
canvas.videoBg.fitResize policy when `inherit` is false.FitModeOptionalDefault—"fill" "contain" "cover"node22 · node24 · node26
canvas.videoBg.formatPublished canvas.videoBg.format option."jpg" | "png"OptionalDefault—"jpg" "png"node22 · node24 · node26
canvas.videoBg.frame1-based frame number. Mutually exclusive with `time`. Defaults to frame 1 when neither selector is provided.numberOptionalDefault——node22 · node24 · node26
canvas.videoBg.inheritAdopt the source image dimensions as the canvas dimensions.booleanOptionalDefault—false truenode22 · node24 · node26
canvas.videoBg.loopPublished canvas.videoBg.loop option.DeprecatedbooleanOptionalDefault—false truenode22 · node24 · node26
canvas.videoBg.opacityBackground-image opacity, multiplied by the canvas-level opacity.numberOptionalDefault——node22 · node24 · node26
canvas.videoBg.qualityFFmpeg image quality value from 1 (best) through 31.numberOptionalDefault——node22 · node24 · node26
canvas.videoBg.sourcePublished canvas.videoBg.source option.string | Buffer<ArrayBufferLike>RequiredDefaultRequired—node22 · node24 · node26
canvas.videoBg.timeTimestamp in seconds. Mutually exclusive with `frame`.numberOptionalDefault——node22 · node24 · node26
canvas.widthPublished canvas.width option.numberOptionalDefault——node22 · node24 · node26
canvas.xPublished canvas.x option.numberOptionalDefault——node22 · node24 · node26
canvas.yPublished canvas.y option.numberOptionalDefault——node22 · node24 · node26
canvas.zoomPublished canvas.zoom option.{ scale?: number; centerX?: number; centerY?: number; }OptionalDefault——node22 · node24 · node26
canvas.zoom.centerXPublished canvas.zoom.centerX option.numberOptionalDefault——node22 · node24 · node26
canvas.zoom.centerYPublished canvas.zoom.centerY option.numberOptionalDefault——node22 · node24 · node26
canvas.zoom.scalePublished canvas.zoom.scale option.numberOptionalDefault——node22 · node24 · node26
painterOpts
painterOpts.resolveAssetRefsWhen **true**, string leaves in the payload are resolved via {@link AssetManager.resolve } (same rules as {@link ApexPainter.prepareForRender } / {@link ApexPainter.renderScene }).booleanOptionalDefault—false truenode22 · node24 · node26

canvas.bgLayers

Optional

Published canvas.bgLayers option.

Type
BackgroundLayer[]
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.bgLayers.blendMode

Optional

Published 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

canvas.bgLayers.opacity

Optional

Published canvas.bgLayers.opacity option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.bgLayers.type

Required

Published canvas.bgLayers.type option.

Type
"color"
Default
Required
Allowed
"color"
Runtime
node22, node24, node26

canvas.bgLayers.value

Required

Published canvas.bgLayers.value option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

canvas.bgLayers.align

Optional

Published 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

canvas.bgLayers.fit

Optional

Published canvas.bgLayers.fit option.

Type
"fill" | "contain" | "cover"
Default
—
Allowed
"fill" "contain" "cover"
Runtime
node22, node24, node26

canvas.bgLayers.source

Required

Published canvas.bgLayers.source option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

canvas.bgLayers.repeat

Optional

Published canvas.bgLayers.repeat option.

Type
BackgroundPatternRepeat
Default
—
Allowed
"repeat" "no-repeat" "repeat-x" "repeat-y"
Runtime
node22, node24, node26

canvas.bgLayers.pattern

Required

Published canvas.bgLayers.pattern option.

Type
PatternOptions
Default
Required
Allowed
—
Runtime
node22, node24, node26

canvas.bgLayers.pattern.blendMode

Optional

Published 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

canvas.bgLayers.pattern.gradient.colors

Required

Published canvas.bgLayers.pattern.gradient.colors option.

Type
{ stop: number; color: string; }[]
Default
Required
Allowed
—
Runtime
node22, node24, node26

canvas.bgLayers.pattern.gradient.repeat

Optional

Published canvas.bgLayers.pattern.gradient.repeat option.

Type
"repeat" | "reflect" | "no-repeat"
Default
—
Allowed
"repeat" "reflect" "no-repeat"
Runtime
node22, node24, node26

canvas.bgLayers.pattern.gradient.type

Required

Published canvas.bgLayers.pattern.gradient.type option.

Type
"linear" | "radial" | "conic"
Default
Required
Allowed
"linear" "radial" "conic"
Runtime
node22, node24, node26

canvas.bgLayers.pattern.repeat

Optional

Published 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

canvas.bgLayers.pattern.size

Optional

Published canvas.bgLayers.pattern.size option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.bgLayers.pattern.type

Required

Published 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

canvas.bgLayers.intensity

Optional

Published canvas.bgLayers.intensity option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.blendMode

Optional

Published 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

canvas.blur

Optional

Published canvas.blur option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.borderPosition

Optional

Published canvas.borderPosition option.

Type
string
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.borderRadius

Optional

Published canvas.borderRadius option.

Type
number | "circular"
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.colorBg

Optional

Published canvas.colorBg option.

Type
string
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.customBg

Optional

Published canvas.customBg option.

Type
CanvasCustomBackground
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.customBg.align

Optional

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

canvas.customBg.filters

Optional

Image filters applied to this background only.

Type
ImageFilter[]
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.customBg.filters.size

Optional

Published canvas.customBg.filters.size option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.customBg.filters.type

Required

Published 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

canvas.customBg.filters.x

Optional

Optional pixelate region. Omit for the whole filtered surface.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.customBg.filters.y

Optional

Published canvas.customBg.filters.y option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.customBg.fit

Optional

Resize policy when `inherit` is false.

Type
FitMode
Default
—
Allowed
"fill" "contain" "cover"
Runtime
node22, node24, node26

canvas.customBg.inherit

Optional

Adopt the source image dimensions as the canvas dimensions.

Type
boolean
Default
—
Allowed
false true
Runtime
node22, node24, node26

canvas.customBg.opacity

Optional

Background-image opacity, multiplied by the canvas-level opacity.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.customBg.source

Required

Published canvas.customBg.source option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

canvas.gradientBg

Optional

Published canvas.gradientBg option.

Type
gradient
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.gradientBg.colors

Required

Published canvas.gradientBg.colors option.

Type
GradientStop[]
Default
Required
Allowed
—
Runtime
node22, node24, node26

canvas.gradientBg.colors.color

Required

Published canvas.gradientBg.colors.color option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

canvas.gradientBg.colors.stop

Required

Published canvas.gradientBg.colors.stop option.

Type
number
Default
Required
Allowed
—
Runtime
node22, node24, node26

canvas.gradientBg.endX

Optional

Published canvas.gradientBg.endX option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.gradientBg.endY

Optional

Published canvas.gradientBg.endY option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.gradientBg.pivotX

Optional

Published canvas.gradientBg.pivotX option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.gradientBg.pivotY

Optional

Published canvas.gradientBg.pivotY option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.gradientBg.repeat

Optional

Published canvas.gradientBg.repeat option.

Type
"repeat" | "reflect" | "no-repeat"
Default
—
Allowed
"repeat" "reflect" "no-repeat"
Runtime
node22, node24, node26

canvas.gradientBg.rotate

Optional

Published canvas.gradientBg.rotate option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.gradientBg.startX

Optional

Published canvas.gradientBg.startX option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.gradientBg.startY

Optional

Published canvas.gradientBg.startY option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.gradientBg.type

Required

Published canvas.gradientBg.type option.

Type
"linear"
Default
Required
Allowed
"linear"
Runtime
node22, node24, node26

canvas.gradientBg.endRadius

Optional

Published canvas.gradientBg.endRadius option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.gradientBg.centerX

Optional

Published canvas.gradientBg.centerX option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.gradientBg.centerY

Optional

Published canvas.gradientBg.centerY option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.gradientBg.startAngle

Optional

Published canvas.gradientBg.startAngle option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.height

Optional

Published canvas.height option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.noiseBg

Optional

Published canvas.noiseBg option.

Type
{ intensity?: number; }
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.noiseBg.intensity

Optional

Published canvas.noiseBg.intensity option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.opacity

Optional

Published canvas.opacity option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.patternBg

Optional

Published canvas.patternBg option.

Type
PatternOptions
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.patternBg.blendMode

Optional

Published 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

canvas.patternBg.color

Optional

Published canvas.patternBg.color option.

Type
string
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.patternBg.gradient

Optional

Published canvas.patternBg.gradient option.

Type
GradientConfig
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.patternBg.gradient.colors

Required

Published canvas.patternBg.gradient.colors option.

Type
{ stop: number; color: string; }[]
Default
Required
Allowed
—
Runtime
node22, node24, node26

canvas.patternBg.gradient.repeat

Optional

Published canvas.patternBg.gradient.repeat option.

Type
"repeat" | "reflect" | "no-repeat"
Default
—
Allowed
"repeat" "reflect" "no-repeat"
Runtime
node22, node24, node26

canvas.patternBg.gradient.type

Required

Published canvas.patternBg.gradient.type option.

Type
"linear" | "radial" | "conic"
Default
Required
Allowed
"linear" "radial" "conic"
Runtime
node22, node24, node26

canvas.patternBg.offsetX

Optional

Published canvas.patternBg.offsetX option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.patternBg.offsetY

Optional

Published canvas.patternBg.offsetY option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.patternBg.opacity

Optional

Published canvas.patternBg.opacity option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.patternBg.repeat

Optional

Published 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

canvas.patternBg.rotation

Optional

Published canvas.patternBg.rotation option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.patternBg.scale

Optional

Published canvas.patternBg.scale option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.patternBg.size

Optional

Published canvas.patternBg.size option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.patternBg.spacing

Optional

Published canvas.patternBg.spacing option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.patternBg.type

Required

Published 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

canvas.rotation

Optional

Published canvas.rotation option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.shadow

Optional

Published canvas.shadow option.

Type
ShadowOptions
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.shadow.blur

Optional

Published canvas.shadow.blur option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.shadow.borderPosition

Optional

Published canvas.shadow.borderPosition option.

Type
string
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.shadow.borderRadius

Optional

Published canvas.shadow.borderRadius option.

Type
number | "circular"
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.shadow.color

Optional

Published canvas.shadow.color option.

Type
string
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.shadow.gradient

Optional

Published canvas.shadow.gradient option.

Type
gradient
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.shadow.gradient.colors

Required

Published canvas.shadow.gradient.colors option.

Type
GradientStop[]
Default
Required
Allowed
—
Runtime
node22, node24, node26

canvas.shadow.gradient.endX

Optional

Published canvas.shadow.gradient.endX option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.shadow.gradient.endY

Optional

Published canvas.shadow.gradient.endY option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.shadow.gradient.repeat

Optional

Published canvas.shadow.gradient.repeat option.

Type
"repeat" | "reflect" | "no-repeat"
Default
—
Allowed
"repeat" "reflect" "no-repeat"
Runtime
node22, node24, node26

canvas.shadow.gradient.type

Required

Published canvas.shadow.gradient.type option.

Type
"linear"
Default
Required
Allowed
"linear"
Runtime
node22, node24, node26

canvas.shadow.offsetX

Optional

Published canvas.shadow.offsetX option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.shadow.offsetY

Optional

Published canvas.shadow.offsetY option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.shadow.opacity

Optional

Published canvas.shadow.opacity option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.shadow.roundedCorners

Optional

Published canvas.shadow.roundedCorners option.

Type
string
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.stroke

Optional

Published canvas.stroke option.

Type
StrokeOptions
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.stroke.blur

Optional

Published canvas.stroke.blur option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.stroke.borderPosition

Optional

Published canvas.stroke.borderPosition option.

Type
string
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.stroke.borderRadius

Optional

Published canvas.stroke.borderRadius option.

Type
number | "circular"
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.stroke.color

Optional

Published canvas.stroke.color option.

Type
string
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.stroke.gradient

Optional

Published canvas.stroke.gradient option.

Type
gradient
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.stroke.gradient.colors

Required

Published canvas.stroke.gradient.colors option.

Type
GradientStop[]
Default
Required
Allowed
—
Runtime
node22, node24, node26

canvas.stroke.gradient.endX

Optional

Published canvas.stroke.gradient.endX option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.stroke.gradient.endY

Optional

Published canvas.stroke.gradient.endY option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.stroke.gradient.repeat

Optional

Published canvas.stroke.gradient.repeat option.

Type
"repeat" | "reflect" | "no-repeat"
Default
—
Allowed
"repeat" "reflect" "no-repeat"
Runtime
node22, node24, node26

canvas.stroke.gradient.type

Required

Published canvas.stroke.gradient.type option.

Type
"linear"
Default
Required
Allowed
"linear"
Runtime
node22, node24, node26

canvas.stroke.opacity

Optional

Published canvas.stroke.opacity option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.stroke.position

Optional

Published canvas.stroke.position option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.stroke.roundedCorners

Optional

Published canvas.stroke.roundedCorners option.

Type
string
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.stroke.style

Optional

Published 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

canvas.stroke.width

Optional

Published canvas.stroke.width option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.transparentBase

Optional

Published canvas.transparentBase option.

Type
boolean
Default
—
Allowed
false true
Runtime
node22, node24, node26

canvas.videoBg

Optional

Published canvas.videoBg option.

Type
CanvasVideoBackground
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.videoBg.align

Optional

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

canvas.videoBg.autoplay

Optional

Published canvas.videoBg.autoplay option.

Type
boolean
Default
—
Allowed
false true
Runtime
node22, node24, node26

canvas.videoBg.filters

Optional

Image filters applied to this background only.

Type
ImageFilter[]
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.videoBg.filters.angle

Optional

Published canvas.videoBg.filters.angle option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.videoBg.filters.size

Optional

Published canvas.videoBg.filters.size option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.videoBg.filters.type

Required

Published 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

canvas.videoBg.filters.value

Optional

Published canvas.videoBg.filters.value option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.videoBg.filters.width

Optional

Published canvas.videoBg.filters.width option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.videoBg.filters.x

Optional

Optional pixelate region. Omit for the whole filtered surface.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.videoBg.filters.y

Optional

Published canvas.videoBg.filters.y option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.videoBg.fit

Optional

Resize policy when `inherit` is false.

Type
FitMode
Default
—
Allowed
"fill" "contain" "cover"
Runtime
node22, node24, node26

canvas.videoBg.format

Optional

Published canvas.videoBg.format option.

Type
"jpg" | "png"
Default
—
Allowed
"jpg" "png"
Runtime
node22, node24, node26

canvas.videoBg.frame

Optional

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

canvas.videoBg.inherit

Optional

Adopt the source image dimensions as the canvas dimensions.

Type
boolean
Default
—
Allowed
false true
Runtime
node22, node24, node26

canvas.videoBg.loop

Optional

Published canvas.videoBg.loop option.

Type
boolean
Default
—
Allowed
false true
Runtime
node22, node24, node26

canvas.videoBg.opacity

Optional

Background-image opacity, multiplied by the canvas-level opacity.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.videoBg.quality

Optional

FFmpeg image quality value from 1 (best) through 31.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.videoBg.source

Required

Published canvas.videoBg.source option.

Type
string | Buffer<ArrayBufferLike>
Default
Required
Allowed
—
Runtime
node22, node24, node26

canvas.videoBg.time

Optional

Timestamp in seconds. Mutually exclusive with `frame`.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.width

Optional

Published canvas.width option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.x

Optional

Published canvas.x option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.y

Optional

Published canvas.y option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.zoom

Optional

Published canvas.zoom option.

Type
{ scale?: number; centerX?: number; centerY?: number; }
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.zoom.centerX

Optional

Published canvas.zoom.centerX option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.zoom.centerY

Optional

Published canvas.zoom.centerY option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

canvas.zoom.scale

Optional

Published canvas.zoom.scale option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

painterOpts.resolveAssetRefs

Optional

When **true**, string leaves in the payload are resolved via {@link AssetManager.resolve } (same rules as {@link ApexPainter.prepareForRender } / {@link ApexPainter.renderScene }).

Type
boolean
Default
—
Allowed
false true
Runtime
node22, node24, node26

Types

CanvasConfig: CanvasConfig
  • width?number
  • height?number
  • x?number
  • y?number
  • customBg?
    CanvasCustomBackground: CanvasCustomBackground
    • sourcestring
    • inherit?boolean
    • fit?
      FitMode
      • variant 1"fill"
      • variant 2"contain"
      • variant 3"cover"
    • 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"
    • 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"
        • intensity?number
        • radius?number
        • angle?number
        • centerX?number
        • centerY?number
        • value?number
        • levels?number
        • size?number
        • x?number
        • y?number
        • width?number
        • height?number
    • opacity?number
  • videoBg?
    CanvasVideoBackground: CanvasVideoBackground
    • source
      string | Buffer<ArrayBufferLike>
      • variant 1string
      • variant 2Buffer<ArrayBufferLike>
    • frame?number
    • time?number
    • format?
      "jpg" | "png"
      • variant 1"jpg"
      • variant 2"png"
    • quality?number
    • loop?boolean
    • autoplay?boolean
    • inherit?boolean
    • fit?
      FitMode
      • variant 1"fill"
      • variant 2"contain"
      • variant 3"cover"
    • 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"
    • 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"
        • intensity?number
        • radius?number
        • angle?number
        • centerX?number
        • centerY?number
        • value?number
        • levels?number
        • size?number
        • x?number
        • y?number
        • width?number
        • height?number
    • opacity?number
  • 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"
        • variant 1"repeat"
        • variant 2"reflect"
        • variant 3"no-repeat"
      • colors
        GradientStop[]
        • variant 1
          GradientStop: GradientStop
          • stopnumber
          • colorstring
    • 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"
        • variant 1"repeat"
        • variant 2"reflect"
        • variant 3"no-repeat"
      • colors
        GradientStop[]
        • variant 1
          GradientStop: GradientStop
          • stopnumber
          • colorstring
    • 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[]
        • variant 1
          GradientStop: GradientStop
          • stopnumber
          • colorstring
  • 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"
    • 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"
    • 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"
    • gradient?
      GradientConfig: GradientConfig
      • type
        "linear" | "radial" | "conic"
        • variant 1"linear"
        • variant 2"radial"
        • variant 3"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"
        • variant 1"repeat"
        • variant 2"reflect"
        • variant 3"no-repeat"
      • colors
        { stop: number; color: string; }[]
        • variant 1
          __type: { stop: number; color: string; }
          • stopnumber
          • colorstring
  • noiseBg?
    __type: { intensity?: number; }
    • intensity?number
  • transparentBase?boolean
  • bgLayers?
    BackgroundLayer[]
    • variant 1
      BackgroundLayer
      • variant 1
        __type: { type: "color"; value: string; opacity?: number; blendMode?: GlobalCompositeOperation; }
        • type"color"
        • valuestring
        • opacity?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 2
        __type: { type: "gradient"; value: gradient; opacity?: number; blendMode?: GlobalCompositeOperation; }
        • type"gradient"
        • value
          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[]; }
        • opacity?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 3
        __type: { type: "image"; source: string; opacity?: number; fit?: "fill" | "contain" | "cover"; align?: AlignMode; blendMode?: GlobalCompositeOperation; }
        • type"image"
        • sourcestring
        • opacity?number
        • fit?
          "fill" | "contain" | "cover"
          • variant 1"fill"
          • variant 2"contain"
          • variant 3"cover"
        • 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"
        • 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 4
        __type: { type: "pattern"; source: string; repeat?: BackgroundPatternRepeat; opacity?: number; blendMode?: GlobalCompositeOperation; }
        • type"pattern"
        • sourcestring
        • repeat?
          BackgroundPatternRepeat
          • variant 1"repeat"
          • variant 2"no-repeat"
          • variant 3"repeat-x"
          • variant 4"repeat-y"
        • opacity?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 5
        __type: { type: "presetPattern"; pattern: PatternOptions; opacity?: number; blendMode?: GlobalCompositeOperation; }
        • type"presetPattern"
        • pattern
          PatternOptions: PatternOptions
          • type"grid" | "dots" | "diagonal" | "stripes" | "waves" | "crosses" | "hexagons" | "checkerboard" | "diamonds" | "triangles" | "stars" | "polka" | "custom"
          • color?string
          • secondaryColor?string
          • opacity?number
          • size?number
          • spacing?number
          • rotation?number
          • customPatternImage?string
          • repeat?"repeat" | "no-repeat" | "repeat-x" | "repeat-y"
          • scale?number
          • offsetX?number
          • offsetY?number
          • blendMode?GlobalCompositeOperation
          • gradient?GradientConfig
        • opacity?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 6
        __type: { type: "noise"; intensity?: number; blendMode?: GlobalCompositeOperation; }
        • type"noise"
        • intensity?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"
  • 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"
  • opacity?number
  • blur?number
  • rotation?number
  • borderRadius?
    number | "circular"
    • variant 1number
    • variant 2"circular"
  • borderPosition?string
  • zoom?
    __type: { scale?: number; centerX?: number; centerY?: number; }
    • scale?number
    • centerX?number
    • centerY?number
  • 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"
          • variant 1"repeat"
          • variant 2"reflect"
          • variant 3"no-repeat"
        • colors
          GradientStop[]
          • variant 1GradientStop
      • 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"
          • variant 1"repeat"
          • variant 2"reflect"
          • variant 3"no-repeat"
        • colors
          GradientStop[]
          • variant 1GradientStop
      • 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[]
          • variant 1GradientStop
    • width?number
    • position?number
    • blur?number
    • opacity?number
    • borderRadius?
      number | "circular"
      • variant 1number
      • variant 2"circular"
    • 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"
  • 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"
          • variant 1"repeat"
          • variant 2"reflect"
          • variant 3"no-repeat"
        • colors
          GradientStop[]
          • variant 1GradientStop
      • 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"
          • variant 1"repeat"
          • variant 2"reflect"
          • variant 3"no-repeat"
        • colors
          GradientStop[]
          • variant 1GradientStop
      • 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[]
          • variant 1GradientStop
    • offsetX?number
    • offsetY?number
    • blur?number
    • opacity?number
    • borderRadius?
      number | "circular"
      • variant 1number
      • variant 2"circular"
    • roundedCorners?string
    • borderPosition?string
PainterAssetRefsOptions: PainterAssetRefsOptions
  • resolveAssetRefs?boolean

Return value

Promise<CanvasResults>

The return contract is generated from the packed declaration. Async wrappers and nullable/undefined variants remain visible in the type model.

Errors

NOT APPLICABLE — no verified errors are bound to this API.

Limits

NOT APPLICABLE — no API-specific verified limits are bound to this API.

Related APIs

No explicit related API metadata.

Verified examples

Create a deterministic canvasDOC-5 · node · minimal · verified

Render a fixed 320×180 server-side PNG using the public ApexPainter canvas API.

Generate a two-frame GIFDOC-5 · node · advanced · verified

Generate a tiny server-side GIF from two Apexify canvas frames and verify its GIF structure.

Next steps

ApexPainter._detectAPI member · node · CURRENT

Published ApexPainter._detect property.

ApexPainter._outputAPI member · node · CURRENT

Published ApexPainter._output property.

ApexPainter._outputFormatAPI member · node · CURRENT

Published ApexPainter._outputFormat property.

ApexPainter._path2dAPI member · node · CURRENT

Published ApexPainter._path2d property.