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

ApexPainter member

ApexPainter.createTemplate

Reusable immutable scene design: native-value `{{placeholders}}`, `$namedAssets`, flex/grid layout nodes, precise `visible` conditionals, unique `id` overrides, and deterministic render-time insertions.

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

Signature

TypeScript
(definition: TemplateSceneDefinition, options?: TemplateOptions) => TemplateHandle

Parameters

definition

TemplateSceneDefinition

Options

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

definition.background

Optional

Root paint configuration only; root dimensions are always `width`/`height`.

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

definition.background.bgLayers

Optional

Published definition.background.bgLayers option.

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

definition.background.bgLayers.blendMode

Optional

Published definition.background.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

definition.background.bgLayers.align

Optional

Published definition.background.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

definition.background.bgLayers.fit

Optional

Published definition.background.bgLayers.fit option.

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

definition.background.bgLayers.repeat

Optional

Published definition.background.bgLayers.repeat option.

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

definition.background.bgLayers.pattern.blendMode

Optional

Published definition.background.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

definition.background.bgLayers.pattern.repeat

Optional

Published definition.background.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

definition.background.bgLayers.pattern.type

Required

Published definition.background.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

definition.background.blendMode

Optional

Published definition.background.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

definition.background.blur

Optional

Published definition.background.blur option.

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

definition.background.customBg

Optional

Published definition.background.customBg option.

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

definition.background.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

definition.background.customBg.filters.type

Required

Published definition.background.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

definition.background.gradientBg.repeat

Optional

Published definition.background.gradientBg.repeat option.

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

definition.background.noiseBg

Optional

Published definition.background.noiseBg option.

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

definition.background.patternBg

Optional

Published definition.background.patternBg option.

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

definition.background.patternBg.blendMode

Optional

Published definition.background.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

definition.background.patternBg.gradient.type

Required

Published definition.background.patternBg.gradient.type option.

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

definition.background.patternBg.repeat

Optional

Published definition.background.patternBg.repeat option.

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

definition.background.patternBg.type

Required

Published definition.background.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

definition.background.shadow

Optional

Published definition.background.shadow option.

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

definition.background.shadow.gradient.repeat

Optional

Published definition.background.shadow.gradient.repeat option.

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

definition.background.stroke

Optional

Published definition.background.stroke option.

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

definition.background.stroke.gradient.repeat

Optional

Published definition.background.stroke.gradient.repeat option.

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

definition.background.stroke.style

Optional

Published definition.background.stroke.style option.

Type
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"
Default
—
Allowed
6 values
"solid" "dashed" "dotted" "groove" "ridge" "double"
Runtime
node22, node24, node26

definition.background.videoBg

Optional

Published definition.background.videoBg option.

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

definition.background.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

definition.background.videoBg.filters.type

Required

Published definition.background.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

definition.background.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

definition.background.videoBg.source

Required

Published definition.background.videoBg.source option.

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

definition.background.x

Optional

Published definition.background.x option.

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

definition.background.y

Optional

Published definition.background.y option.

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

definition.background.zoom

Optional

Published definition.background.zoom option.

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

definition.height

Required

Published definition.height option.

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

definition.layers

Required

Published definition.layers option.

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

definition.width

Required

Published definition.width option.

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

options.resolveAssetRef

Optional

Optional asset resolver override; painter.assets is used when omitted.

Type
(value: string) => AssetValue
Default
—
Allowed
—
Runtime
node22, node24, node26

Types

TemplateSceneDefinition
  • variant 1Omit<SceneRenderInput, "layers">
  • variant 2
    __type: { layers: TemplateLayerInput[]; }
    • layers
      TemplateLayerInput[]
      • variant 1TemplateLayerInput
TemplateOptions: TemplateOptions
  • resolveAssetRef?(value: string) => AssetValue

Return value

TemplateHandle

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.

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.