ApexPainter member
ApexPainter.renderSceneToVideoFrames
Published ApexPainter.renderSceneToVideoFrames method.
lib-next/apex-painter/main.ts (opens in a new tab)Signature
(scene: SceneRenderInput, video: { options: VideoCreationOptions; prependComposedToFrames?: boolean; framesWithRepeats?: SceneVideoFrameSlot[]; sceneRender?: SceneRenderOptions; }) => Promise<SceneToVideoResult>Parameters
Options
| Option | Type | Contract | Allowed values | Runtime & capabilities |
|---|---|---|---|---|
| scene | ||||
scene.backgroundRoot paint configuration only; root dimensions are always `width`/`height`. | SceneBackground | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayersPublished scene.background.bgLayers option. | BackgroundLayer[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.blendModePublished scene.background.bgLayers.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
scene.background.bgLayers.opacityPublished scene.background.bgLayers.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.typePublished scene.background.bgLayers.type option. | "color" | RequiredDefaultRequired | "color" | node22 · node24 · node26 |
scene.background.bgLayers.valuePublished scene.background.bgLayers.value option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.background.bgLayers.alignPublished scene.background.bgLayers.align option. | AlignMode | OptionalDefault— | 9 values"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" | node22 · node24 · node26 |
scene.background.bgLayers.fitPublished scene.background.bgLayers.fit option. | "fill" | "contain" | "cover" | OptionalDefault— | "fill" "contain" "cover" | node22 · node24 · node26 |
scene.background.bgLayers.sourcePublished scene.background.bgLayers.source option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.background.bgLayers.repeatPublished scene.background.bgLayers.repeat option. | BackgroundPatternRepeat | OptionalDefault— | "repeat" "no-repeat" "repeat-x" "repeat-y" | node22 · node24 · node26 |
scene.background.bgLayers.patternPublished scene.background.bgLayers.pattern option. | PatternOptions | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.blendModePublished scene.background.bgLayers.pattern.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
scene.background.bgLayers.pattern.colorPublished scene.background.bgLayers.pattern.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.customPatternImagePublished scene.background.bgLayers.pattern.customPatternImage option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.gradientPublished scene.background.bgLayers.pattern.gradient option. | GradientConfig | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.gradient.anglePublished scene.background.bgLayers.pattern.gradient.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.gradient.centerXPublished scene.background.bgLayers.pattern.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.gradient.centerYPublished scene.background.bgLayers.pattern.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.gradient.colorsPublished scene.background.bgLayers.pattern.gradient.colors option. | { stop: number; color: string; }[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.gradient.colors.colorPublished scene.background.bgLayers.pattern.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.gradient.colors.stopPublished scene.background.bgLayers.pattern.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.gradient.endRadiusPublished scene.background.bgLayers.pattern.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.gradient.endXPublished scene.background.bgLayers.pattern.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.gradient.endYPublished scene.background.bgLayers.pattern.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.gradient.repeatPublished scene.background.bgLayers.pattern.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.background.bgLayers.pattern.gradient.startAnglePublished scene.background.bgLayers.pattern.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.gradient.startRadiusPublished scene.background.bgLayers.pattern.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.gradient.startXPublished scene.background.bgLayers.pattern.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.gradient.startYPublished scene.background.bgLayers.pattern.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.gradient.typePublished scene.background.bgLayers.pattern.gradient.type option. | "linear" | "radial" | "conic" | RequiredDefaultRequired | "linear" "radial" "conic" | node22 · node24 · node26 |
scene.background.bgLayers.pattern.offsetXPublished scene.background.bgLayers.pattern.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.offsetYPublished scene.background.bgLayers.pattern.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.opacityPublished scene.background.bgLayers.pattern.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.repeatPublished scene.background.bgLayers.pattern.repeat option. | "repeat" | "no-repeat" | "repeat-x" | "repeat-y" | OptionalDefault— | "repeat" "no-repeat" "repeat-x" "repeat-y" | node22 · node24 · node26 |
scene.background.bgLayers.pattern.rotationPublished scene.background.bgLayers.pattern.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.scalePublished scene.background.bgLayers.pattern.scale option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.secondaryColorPublished scene.background.bgLayers.pattern.secondaryColor option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.sizePublished scene.background.bgLayers.pattern.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.spacingPublished scene.background.bgLayers.pattern.spacing option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.bgLayers.pattern.typePublished scene.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 |
scene.background.bgLayers.intensityPublished scene.background.bgLayers.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.blendModePublished scene.background.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
scene.background.blurPublished scene.background.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.borderPositionPublished scene.background.borderPosition option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.borderRadiusPublished scene.background.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.colorBgPublished scene.background.colorBg option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.customBgPublished scene.background.customBg option. | CanvasCustomBackground | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.customBg.alignPlacement used by `contain` / `cover` when `inherit` is false. | AlignMode | OptionalDefault— | 9 values"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" | node22 · node24 · node26 |
scene.background.customBg.filtersImage filters applied to this background only. | ImageFilter[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.customBg.filters.anglePublished scene.background.customBg.filters.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.customBg.filters.centerXPublished scene.background.customBg.filters.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.customBg.filters.centerYPublished scene.background.customBg.filters.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.customBg.filters.heightPublished scene.background.customBg.filters.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.customBg.filters.intensityPublished scene.background.customBg.filters.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.customBg.filters.levelsPublished scene.background.customBg.filters.levels option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.customBg.filters.radiusPublished scene.background.customBg.filters.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.customBg.filters.sizePublished scene.background.customBg.filters.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.customBg.filters.typePublished scene.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 |
scene.background.customBg.filters.valuePublished scene.background.customBg.filters.value option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.customBg.filters.widthPublished scene.background.customBg.filters.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.customBg.filters.xOptional pixelate region. Omit for the whole filtered surface. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.customBg.filters.yPublished scene.background.customBg.filters.y option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.customBg.fitResize policy when `inherit` is false. | FitMode | OptionalDefault— | "fill" "contain" "cover" | node22 · node24 · node26 |
scene.background.customBg.inheritAdopt the source image dimensions as the canvas dimensions. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.background.customBg.opacityBackground-image opacity, multiplied by the canvas-level opacity. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.customBg.sourcePublished scene.background.customBg.source option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.background.gradientBgPublished scene.background.gradientBg option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.gradientBg.colorsPublished scene.background.gradientBg.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.background.gradientBg.colors.colorPublished scene.background.gradientBg.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.background.gradientBg.colors.stopPublished scene.background.gradientBg.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.background.gradientBg.endXPublished scene.background.gradientBg.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.gradientBg.endYPublished scene.background.gradientBg.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.gradientBg.pivotXPublished scene.background.gradientBg.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.gradientBg.pivotYPublished scene.background.gradientBg.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.gradientBg.repeatPublished scene.background.gradientBg.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.background.gradientBg.rotatePublished scene.background.gradientBg.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.gradientBg.startXPublished scene.background.gradientBg.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.gradientBg.startYPublished scene.background.gradientBg.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.gradientBg.typePublished scene.background.gradientBg.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.background.gradientBg.endRadiusPublished scene.background.gradientBg.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.gradientBg.startRadiusPublished scene.background.gradientBg.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.gradientBg.centerXPublished scene.background.gradientBg.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.gradientBg.centerYPublished scene.background.gradientBg.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.gradientBg.startAnglePublished scene.background.gradientBg.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.noiseBgPublished scene.background.noiseBg option. | { intensity?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.noiseBg.intensityPublished scene.background.noiseBg.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.opacityPublished scene.background.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBgPublished scene.background.patternBg option. | PatternOptions | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.blendModePublished scene.background.patternBg.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
scene.background.patternBg.colorPublished scene.background.patternBg.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.customPatternImagePublished scene.background.patternBg.customPatternImage option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.gradientPublished scene.background.patternBg.gradient option. | GradientConfig | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.gradient.anglePublished scene.background.patternBg.gradient.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.gradient.centerXPublished scene.background.patternBg.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.gradient.centerYPublished scene.background.patternBg.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.gradient.colorsPublished scene.background.patternBg.gradient.colors option. | { stop: number; color: string; }[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.background.patternBg.gradient.colors.colorPublished scene.background.patternBg.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.background.patternBg.gradient.colors.stopPublished scene.background.patternBg.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.background.patternBg.gradient.endRadiusPublished scene.background.patternBg.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.gradient.endXPublished scene.background.patternBg.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.gradient.endYPublished scene.background.patternBg.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.gradient.repeatPublished scene.background.patternBg.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.background.patternBg.gradient.startAnglePublished scene.background.patternBg.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.gradient.startRadiusPublished scene.background.patternBg.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.gradient.startXPublished scene.background.patternBg.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.gradient.startYPublished scene.background.patternBg.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.gradient.typePublished scene.background.patternBg.gradient.type option. | "linear" | "radial" | "conic" | RequiredDefaultRequired | "linear" "radial" "conic" | node22 · node24 · node26 |
scene.background.patternBg.offsetXPublished scene.background.patternBg.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.offsetYPublished scene.background.patternBg.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.opacityPublished scene.background.patternBg.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.repeatPublished scene.background.patternBg.repeat option. | "repeat" | "no-repeat" | "repeat-x" | "repeat-y" | OptionalDefault— | "repeat" "no-repeat" "repeat-x" "repeat-y" | node22 · node24 · node26 |
scene.background.patternBg.rotationPublished scene.background.patternBg.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.scalePublished scene.background.patternBg.scale option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.secondaryColorPublished scene.background.patternBg.secondaryColor option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.sizePublished scene.background.patternBg.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.spacingPublished scene.background.patternBg.spacing option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.patternBg.typePublished scene.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 |
scene.background.rotationPublished scene.background.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadowPublished scene.background.shadow option. | ShadowOptions | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.blurPublished scene.background.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.borderPositionPublished scene.background.shadow.borderPosition option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.borderRadiusPublished scene.background.shadow.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.colorPublished scene.background.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.gradientPublished scene.background.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.gradient.colorsPublished scene.background.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.background.shadow.gradient.colors.colorPublished scene.background.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.background.shadow.gradient.colors.stopPublished scene.background.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.background.shadow.gradient.endXPublished scene.background.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.gradient.endYPublished scene.background.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.gradient.pivotXPublished scene.background.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.gradient.pivotYPublished scene.background.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.gradient.repeatPublished scene.background.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.background.shadow.gradient.rotatePublished scene.background.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.gradient.startXPublished scene.background.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.gradient.startYPublished scene.background.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.gradient.typePublished scene.background.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.background.shadow.gradient.endRadiusPublished scene.background.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.gradient.startRadiusPublished scene.background.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.gradient.centerXPublished scene.background.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.gradient.centerYPublished scene.background.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.gradient.startAnglePublished scene.background.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.offsetXPublished scene.background.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.offsetYPublished scene.background.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.opacityPublished scene.background.shadow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.shadow.roundedCornersPublished scene.background.shadow.roundedCorners option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.strokePublished scene.background.stroke option. | StrokeOptions | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.blurPublished scene.background.stroke.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.borderPositionPublished scene.background.stroke.borderPosition option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.borderRadiusPublished scene.background.stroke.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.colorPublished scene.background.stroke.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.gradientPublished scene.background.stroke.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.gradient.colorsPublished scene.background.stroke.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.background.stroke.gradient.colors.colorPublished scene.background.stroke.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.background.stroke.gradient.colors.stopPublished scene.background.stroke.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.background.stroke.gradient.endXPublished scene.background.stroke.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.gradient.endYPublished scene.background.stroke.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.gradient.pivotXPublished scene.background.stroke.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.gradient.pivotYPublished scene.background.stroke.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.gradient.repeatPublished scene.background.stroke.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.background.stroke.gradient.rotatePublished scene.background.stroke.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.gradient.startXPublished scene.background.stroke.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.gradient.startYPublished scene.background.stroke.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.gradient.typePublished scene.background.stroke.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.background.stroke.gradient.endRadiusPublished scene.background.stroke.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.gradient.startRadiusPublished scene.background.stroke.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.gradient.centerXPublished scene.background.stroke.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.gradient.centerYPublished scene.background.stroke.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.gradient.startAnglePublished scene.background.stroke.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.opacityPublished scene.background.stroke.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.positionPublished scene.background.stroke.position option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.roundedCornersPublished scene.background.stroke.roundedCorners option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.stroke.stylePublished scene.background.stroke.style option. | "solid" | "dashed" | "dotted" | "groove" | "ridge" | "double" | OptionalDefault— | 6 values"solid" "dashed" "dotted" "groove" "ridge" "double" | node22 · node24 · node26 |
scene.background.stroke.widthPublished scene.background.stroke.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.transparentBasePublished scene.background.transparentBase option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.background.videoBgPublished scene.background.videoBg option. | CanvasVideoBackground | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.videoBg.alignPlacement used by `contain` / `cover` when `inherit` is false. | AlignMode | OptionalDefault— | 9 values"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" | node22 · node24 · node26 |
scene.background.videoBg.autoplayPublished scene.background.videoBg.autoplay option.Deprecated | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.background.videoBg.filtersImage filters applied to this background only. | ImageFilter[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.videoBg.filters.anglePublished scene.background.videoBg.filters.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.videoBg.filters.centerXPublished scene.background.videoBg.filters.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.videoBg.filters.centerYPublished scene.background.videoBg.filters.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.videoBg.filters.heightPublished scene.background.videoBg.filters.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.videoBg.filters.intensityPublished scene.background.videoBg.filters.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.videoBg.filters.levelsPublished scene.background.videoBg.filters.levels option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.videoBg.filters.radiusPublished scene.background.videoBg.filters.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.videoBg.filters.sizePublished scene.background.videoBg.filters.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.videoBg.filters.typePublished scene.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 |
scene.background.videoBg.filters.valuePublished scene.background.videoBg.filters.value option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.videoBg.filters.widthPublished scene.background.videoBg.filters.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.videoBg.filters.xOptional pixelate region. Omit for the whole filtered surface. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.videoBg.filters.yPublished scene.background.videoBg.filters.y option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.videoBg.fitResize policy when `inherit` is false. | FitMode | OptionalDefault— | "fill" "contain" "cover" | node22 · node24 · node26 |
scene.background.videoBg.formatPublished scene.background.videoBg.format option. | "jpg" | "png" | OptionalDefault— | "jpg" "png" | node22 · node24 · node26 |
scene.background.videoBg.frame1-based frame number. Mutually exclusive with `time`. Defaults to frame 1 when neither selector is provided. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.videoBg.inheritAdopt the source image dimensions as the canvas dimensions. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.background.videoBg.loopPublished scene.background.videoBg.loop option.Deprecated | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.background.videoBg.opacityBackground-image opacity, multiplied by the canvas-level opacity. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.videoBg.qualityFFmpeg image quality value from 1 (best) through 31. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.videoBg.sourcePublished scene.background.videoBg.source option. | string | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.background.videoBg.timeTimestamp in seconds. Mutually exclusive with `frame`. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.xPublished scene.background.x option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.yPublished scene.background.y option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.zoomPublished scene.background.zoom option. | { scale?: number; centerX?: number; centerY?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.zoom.centerXPublished scene.background.zoom.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.zoom.centerYPublished scene.background.zoom.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.background.zoom.scalePublished scene.background.zoom.scale option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.heightPublished scene.height option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layersPublished scene.layers option. | SceneLayer[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.imagesPublished scene.layers.images option. | ImageProperties | ImageProperties[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.alignPublished scene.layers.images.align option. | AlignMode | OptionalDefault— | 9 values"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" | node22 · node24 · node26 |
scene.layers.images.blendModePublished scene.layers.images.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
scene.layers.images.blurPublished scene.layers.images.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.borderPositionPublished scene.layers.images.borderPosition option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.borderRadiusPublished scene.layers.images.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.boxBackgroundPublished scene.layers.images.boxBackground option. | BoxBackground | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.boxBackground.colorPublished scene.layers.images.boxBackground.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.boxBackground.gradientPublished scene.layers.images.boxBackground.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.boxBackground.gradient.colorsPublished scene.layers.images.boxBackground.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.boxBackground.gradient.colors.colorPublished scene.layers.images.boxBackground.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.boxBackground.gradient.colors.stopPublished scene.layers.images.boxBackground.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.boxBackground.gradient.endXPublished scene.layers.images.boxBackground.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.boxBackground.gradient.endYPublished scene.layers.images.boxBackground.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.boxBackground.gradient.pivotXPublished scene.layers.images.boxBackground.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.boxBackground.gradient.pivotYPublished scene.layers.images.boxBackground.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.boxBackground.gradient.repeatPublished scene.layers.images.boxBackground.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.images.boxBackground.gradient.rotatePublished scene.layers.images.boxBackground.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.boxBackground.gradient.startXPublished scene.layers.images.boxBackground.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.boxBackground.gradient.startYPublished scene.layers.images.boxBackground.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.boxBackground.gradient.typePublished scene.layers.images.boxBackground.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.images.boxBackground.gradient.endRadiusPublished scene.layers.images.boxBackground.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.boxBackground.gradient.startRadiusPublished scene.layers.images.boxBackground.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.boxBackground.gradient.centerXPublished scene.layers.images.boxBackground.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.boxBackground.gradient.centerYPublished scene.layers.images.boxBackground.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.boxBackground.gradient.startAnglePublished scene.layers.images.boxBackground.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.clipPathPublished scene.layers.images.clipPath option. | { x: number; y: number; }[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.clipPath.xPublished scene.layers.images.clipPath.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.clipPath.yPublished scene.layers.images.clipPath.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.distortionPublished scene.layers.images.distortion option. | { type: "perspective" | "warp" | "bulge" | "pinch"; points?: { x: number; y: number; }[]; intensity?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.distortion.intensityPublished scene.layers.images.distortion.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.distortion.pointsPublished scene.layers.images.distortion.points option. | { x: number; y: number; }[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.distortion.points.xPublished scene.layers.images.distortion.points.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.distortion.points.yPublished scene.layers.images.distortion.points.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.distortion.typePublished scene.layers.images.distortion.type option. | "perspective" | "warp" | "bulge" | "pinch" | RequiredDefaultRequired | "perspective" "warp" "bulge" "pinch" | node22 · node24 · node26 |
scene.layers.images.effectsPublished scene.layers.images.effects option. | { vignette?: { intensity: number; size: number; }; lensFlare?: { x: number; y: number; intensity: number; }; chromaticAberration?: { intensity: number; }; filmGrain?: { intensity: number; }; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.effects.chromaticAberrationPublished scene.layers.images.effects.chromaticAberration option. | { intensity: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.effects.chromaticAberration.intensityPublished scene.layers.images.effects.chromaticAberration.intensity option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.effects.filmGrainPublished scene.layers.images.effects.filmGrain option. | { intensity: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.effects.filmGrain.intensityPublished scene.layers.images.effects.filmGrain.intensity option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.effects.lensFlarePublished scene.layers.images.effects.lensFlare option. | { x: number; y: number; intensity: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.effects.lensFlare.intensityPublished scene.layers.images.effects.lensFlare.intensity option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.effects.lensFlare.xPublished scene.layers.images.effects.lensFlare.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.effects.lensFlare.yPublished scene.layers.images.effects.lensFlare.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.effects.vignettePublished scene.layers.images.effects.vignette option. | { intensity: number; size: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.effects.vignette.intensityPublished scene.layers.images.effects.vignette.intensity option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.effects.vignette.sizePublished scene.layers.images.effects.vignette.size option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.filterIntensityPublished scene.layers.images.filterIntensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.filterOrderPublished scene.layers.images.filterOrder option. | "pre" | "post" | OptionalDefault— | "pre" "post" | node22 · node24 · node26 |
scene.layers.images.filtersPublished scene.layers.images.filters option. | ImageFilter[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.filters.anglePublished scene.layers.images.filters.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.filters.centerXPublished scene.layers.images.filters.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.filters.centerYPublished scene.layers.images.filters.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.filters.heightPublished scene.layers.images.filters.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.filters.intensityPublished scene.layers.images.filters.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.filters.levelsPublished scene.layers.images.filters.levels option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.filters.radiusPublished scene.layers.images.filters.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.filters.sizePublished scene.layers.images.filters.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.filters.typePublished scene.layers.images.filters.type option. | "saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize" | RequiredDefaultRequired | 17 values"saturation" "gaussianBlur" "motionBlur" "radialBlur" "sharpen" "noise" "grain" "edgeDetection" "emboss" "invert" "grayscale" "sepia" "pixelate" "brightness" "contrast" "hueShift" "posterize" | node22 · node24 · node26 |
scene.layers.images.filters.valuePublished scene.layers.images.filters.value option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.filters.widthPublished scene.layers.images.filters.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.filters.xOptional pixelate region. Omit for the whole filtered surface. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.filters.yPublished scene.layers.images.filters.y option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.fitPublished scene.layers.images.fit option. | FitMode | OptionalDefault— | "fill" "contain" "cover" | node22 · node24 · node26 |
scene.layers.images.heightPublished scene.layers.images.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.inheritPublished scene.layers.images.inherit option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.images.maskPublished scene.layers.images.mask option. | { source: string | Buffer<ArrayBufferLike>; mode?: "alpha" | "luminance" | "inverse"; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.mask.modePublished scene.layers.images.mask.mode option. | "alpha" | "luminance" | "inverse" | OptionalDefault— | "alpha" "luminance" "inverse" | node22 · node24 · node26 |
scene.layers.images.mask.sourcePublished scene.layers.images.mask.source option. | string | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.meshWarpPublished scene.layers.images.meshWarp option. | { gridX?: number; gridY?: number; controlPoints?: { x: number; y: number; }[][]; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.meshWarp.controlPointsPublished scene.layers.images.meshWarp.controlPoints option. | { x: number; y: number; }[][] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.meshWarp.controlPoints.xPublished scene.layers.images.meshWarp.controlPoints.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.meshWarp.controlPoints.yPublished scene.layers.images.meshWarp.controlPoints.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.meshWarp.gridXPublished scene.layers.images.meshWarp.gridX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.meshWarp.gridYPublished scene.layers.images.meshWarp.gridY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.opacityPublished scene.layers.images.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.rotationPublished scene.layers.images.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadowPublished scene.layers.images.shadow option. | ShadowOptions | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.blurPublished scene.layers.images.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.borderPositionPublished scene.layers.images.shadow.borderPosition option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.borderRadiusPublished scene.layers.images.shadow.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.colorPublished scene.layers.images.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.gradientPublished scene.layers.images.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.gradient.colorsPublished scene.layers.images.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.shadow.gradient.colors.colorPublished scene.layers.images.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.shadow.gradient.colors.stopPublished scene.layers.images.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.shadow.gradient.endXPublished scene.layers.images.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.gradient.endYPublished scene.layers.images.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.gradient.pivotXPublished scene.layers.images.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.gradient.pivotYPublished scene.layers.images.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.gradient.repeatPublished scene.layers.images.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.images.shadow.gradient.rotatePublished scene.layers.images.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.gradient.startXPublished scene.layers.images.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.gradient.startYPublished scene.layers.images.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.gradient.typePublished scene.layers.images.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.images.shadow.gradient.endRadiusPublished scene.layers.images.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.gradient.startRadiusPublished scene.layers.images.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.gradient.centerXPublished scene.layers.images.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.gradient.centerYPublished scene.layers.images.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.gradient.startAnglePublished scene.layers.images.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.offsetXPublished scene.layers.images.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.offsetYPublished scene.layers.images.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.opacityPublished scene.layers.images.shadow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shadow.roundedCornersPublished scene.layers.images.shadow.roundedCorners option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shapePublished scene.layers.images.shape option. | ShapeProperties | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.centerXPublished scene.layers.images.shape.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.centerYPublished scene.layers.images.shape.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.colorPublished scene.layers.images.shape.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.endAnglePublished scene.layers.images.shape.endAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.fillPublished scene.layers.images.shape.fill option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.images.shape.gradientPublished scene.layers.images.shape.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.gradient.colorsPublished scene.layers.images.shape.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.shape.gradient.colors.colorPublished scene.layers.images.shape.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.shape.gradient.colors.stopPublished scene.layers.images.shape.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.shape.gradient.endXPublished scene.layers.images.shape.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.gradient.endYPublished scene.layers.images.shape.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.gradient.pivotXPublished scene.layers.images.shape.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.gradient.pivotYPublished scene.layers.images.shape.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.gradient.repeatPublished scene.layers.images.shape.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.images.shape.gradient.rotatePublished scene.layers.images.shape.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.gradient.startXPublished scene.layers.images.shape.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.gradient.startYPublished scene.layers.images.shape.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.gradient.typePublished scene.layers.images.shape.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.images.shape.gradient.endRadiusPublished scene.layers.images.shape.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.gradient.startRadiusPublished scene.layers.images.shape.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.gradient.centerXPublished scene.layers.images.shape.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.gradient.centerYPublished scene.layers.images.shape.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.gradient.startAnglePublished scene.layers.images.shape.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.innerRadiusPublished scene.layers.images.shape.innerRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.outerRadiusPublished scene.layers.images.shape.outerRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.pointsPublished scene.layers.images.shape.points option. | { x: number; y: number; }[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.points.xPublished scene.layers.images.shape.points.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.shape.points.yPublished scene.layers.images.shape.points.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.shape.radiusPublished scene.layers.images.shape.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.sidesPublished scene.layers.images.shape.sides option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.shape.startAnglePublished scene.layers.images.shape.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.sourcePublished scene.layers.images.source option. | string | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.strokePublished scene.layers.images.stroke option. | StrokeOptions | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.blurPublished scene.layers.images.stroke.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.borderPositionPublished scene.layers.images.stroke.borderPosition option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.borderRadiusPublished scene.layers.images.stroke.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.colorPublished scene.layers.images.stroke.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.gradientPublished scene.layers.images.stroke.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.gradient.colorsPublished scene.layers.images.stroke.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.stroke.gradient.colors.colorPublished scene.layers.images.stroke.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.stroke.gradient.colors.stopPublished scene.layers.images.stroke.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.stroke.gradient.endXPublished scene.layers.images.stroke.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.gradient.endYPublished scene.layers.images.stroke.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.gradient.pivotXPublished scene.layers.images.stroke.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.gradient.pivotYPublished scene.layers.images.stroke.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.gradient.repeatPublished scene.layers.images.stroke.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.images.stroke.gradient.rotatePublished scene.layers.images.stroke.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.gradient.startXPublished scene.layers.images.stroke.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.gradient.startYPublished scene.layers.images.stroke.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.gradient.typePublished scene.layers.images.stroke.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.images.stroke.gradient.endRadiusPublished scene.layers.images.stroke.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.gradient.startRadiusPublished scene.layers.images.stroke.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.gradient.centerXPublished scene.layers.images.stroke.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.gradient.centerYPublished scene.layers.images.stroke.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.gradient.startAnglePublished scene.layers.images.stroke.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.opacityPublished scene.layers.images.stroke.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.positionPublished scene.layers.images.stroke.position option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.roundedCornersPublished scene.layers.images.stroke.roundedCorners option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.stroke.stylePublished scene.layers.images.stroke.style option. | "solid" | "dashed" | "dotted" | "groove" | "ridge" | "double" | OptionalDefault— | 6 values"solid" "dashed" "dotted" "groove" "ridge" "double" | node22 · node24 · node26 |
scene.layers.images.stroke.widthPublished scene.layers.images.stroke.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.widthPublished scene.layers.images.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.images.xPublished scene.layers.images.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.images.yPublished scene.layers.images.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.optionsPublished scene.layers.options option. | CreateImageOptions | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransformPublished scene.layers.options.groupTransform option. | GroupTransformOptions | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.blendModePublished scene.layers.options.groupTransform.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
scene.layers.options.groupTransform.blurPublished scene.layers.options.groupTransform.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.borderPositionPublished scene.layers.options.groupTransform.borderPosition option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.borderRadiusPublished scene.layers.options.groupTransform.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.boxBackgroundPublished scene.layers.options.groupTransform.boxBackground option. | BoxBackground | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.boxBackground.colorPublished scene.layers.options.groupTransform.boxBackground.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.boxBackground.gradientPublished scene.layers.options.groupTransform.boxBackground.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.boxBackground.gradient.colorsPublished scene.layers.options.groupTransform.boxBackground.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.boxBackground.gradient.colors.colorPublished scene.layers.options.groupTransform.boxBackground.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.boxBackground.gradient.colors.stopPublished scene.layers.options.groupTransform.boxBackground.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.boxBackground.gradient.endXPublished scene.layers.options.groupTransform.boxBackground.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.boxBackground.gradient.endYPublished scene.layers.options.groupTransform.boxBackground.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.boxBackground.gradient.pivotXPublished scene.layers.options.groupTransform.boxBackground.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.boxBackground.gradient.pivotYPublished scene.layers.options.groupTransform.boxBackground.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.boxBackground.gradient.repeatPublished scene.layers.options.groupTransform.boxBackground.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.options.groupTransform.boxBackground.gradient.rotatePublished scene.layers.options.groupTransform.boxBackground.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.boxBackground.gradient.startXPublished scene.layers.options.groupTransform.boxBackground.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.boxBackground.gradient.startYPublished scene.layers.options.groupTransform.boxBackground.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.boxBackground.gradient.typePublished scene.layers.options.groupTransform.boxBackground.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.options.groupTransform.boxBackground.gradient.endRadiusPublished scene.layers.options.groupTransform.boxBackground.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.boxBackground.gradient.startRadiusPublished scene.layers.options.groupTransform.boxBackground.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.boxBackground.gradient.centerXPublished scene.layers.options.groupTransform.boxBackground.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.boxBackground.gradient.centerYPublished scene.layers.options.groupTransform.boxBackground.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.boxBackground.gradient.startAnglePublished scene.layers.options.groupTransform.boxBackground.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.clipPathPublished scene.layers.options.groupTransform.clipPath option. | { x: number; y: number; }[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.clipPath.xPublished scene.layers.options.groupTransform.clipPath.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.clipPath.yPublished scene.layers.options.groupTransform.clipPath.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.distortionPublished scene.layers.options.groupTransform.distortion option. | { type: "perspective" | "warp" | "bulge" | "pinch"; points?: { x: number; y: number; }[]; intensity?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.distortion.intensityPublished scene.layers.options.groupTransform.distortion.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.distortion.pointsPublished scene.layers.options.groupTransform.distortion.points option. | { x: number; y: number; }[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.distortion.points.xPublished scene.layers.options.groupTransform.distortion.points.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.distortion.points.yPublished scene.layers.options.groupTransform.distortion.points.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.distortion.typePublished scene.layers.options.groupTransform.distortion.type option. | "perspective" | "warp" | "bulge" | "pinch" | RequiredDefaultRequired | "perspective" "warp" "bulge" "pinch" | node22 · node24 · node26 |
scene.layers.options.groupTransform.effectsPublished scene.layers.options.groupTransform.effects option. | { vignette?: { intensity: number; size: number; }; lensFlare?: { x: number; y: number; intensity: number; }; chromaticAberration?: { intensity: number; }; filmGrain?: { intensity: number; }; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.effects.chromaticAberrationPublished scene.layers.options.groupTransform.effects.chromaticAberration option. | { intensity: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.effects.chromaticAberration.intensityPublished scene.layers.options.groupTransform.effects.chromaticAberration.intensity option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.effects.filmGrainPublished scene.layers.options.groupTransform.effects.filmGrain option. | { intensity: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.effects.filmGrain.intensityPublished scene.layers.options.groupTransform.effects.filmGrain.intensity option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.effects.lensFlarePublished scene.layers.options.groupTransform.effects.lensFlare option. | { x: number; y: number; intensity: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.effects.lensFlare.intensityPublished scene.layers.options.groupTransform.effects.lensFlare.intensity option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.effects.lensFlare.xPublished scene.layers.options.groupTransform.effects.lensFlare.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.effects.lensFlare.yPublished scene.layers.options.groupTransform.effects.lensFlare.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.effects.vignettePublished scene.layers.options.groupTransform.effects.vignette option. | { intensity: number; size: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.effects.vignette.intensityPublished scene.layers.options.groupTransform.effects.vignette.intensity option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.effects.vignette.sizePublished scene.layers.options.groupTransform.effects.vignette.size option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.filterIntensityPublished scene.layers.options.groupTransform.filterIntensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.filterOrderPublished scene.layers.options.groupTransform.filterOrder option. | "pre" | "post" | OptionalDefault— | "pre" "post" | node22 · node24 · node26 |
scene.layers.options.groupTransform.filtersPublished scene.layers.options.groupTransform.filters option. | ImageFilter[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.filters.anglePublished scene.layers.options.groupTransform.filters.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.filters.centerXPublished scene.layers.options.groupTransform.filters.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.filters.centerYPublished scene.layers.options.groupTransform.filters.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.filters.heightPublished scene.layers.options.groupTransform.filters.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.filters.intensityPublished scene.layers.options.groupTransform.filters.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.filters.levelsPublished scene.layers.options.groupTransform.filters.levels option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.filters.radiusPublished scene.layers.options.groupTransform.filters.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.filters.sizePublished scene.layers.options.groupTransform.filters.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.filters.typePublished scene.layers.options.groupTransform.filters.type option. | "saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize" | RequiredDefaultRequired | 17 values"saturation" "gaussianBlur" "motionBlur" "radialBlur" "sharpen" "noise" "grain" "edgeDetection" "emboss" "invert" "grayscale" "sepia" "pixelate" "brightness" "contrast" "hueShift" "posterize" | node22 · node24 · node26 |
scene.layers.options.groupTransform.filters.valuePublished scene.layers.options.groupTransform.filters.value option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.filters.widthPublished scene.layers.options.groupTransform.filters.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.filters.xOptional pixelate region. Omit for the whole filtered surface. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.filters.yPublished scene.layers.options.groupTransform.filters.y option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.maskPublished scene.layers.options.groupTransform.mask option. | { source: string | Buffer<ArrayBufferLike>; mode?: "alpha" | "luminance" | "inverse"; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.mask.modePublished scene.layers.options.groupTransform.mask.mode option. | "alpha" | "luminance" | "inverse" | OptionalDefault— | "alpha" "luminance" "inverse" | node22 · node24 · node26 |
scene.layers.options.groupTransform.mask.sourcePublished scene.layers.options.groupTransform.mask.source option. | string | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.meshWarpPublished scene.layers.options.groupTransform.meshWarp option. | { gridX?: number; gridY?: number; controlPoints?: { x: number; y: number; }[][]; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.meshWarp.controlPointsPublished scene.layers.options.groupTransform.meshWarp.controlPoints option. | { x: number; y: number; }[][] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.meshWarp.controlPoints.xPublished scene.layers.options.groupTransform.meshWarp.controlPoints.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.meshWarp.controlPoints.yPublished scene.layers.options.groupTransform.meshWarp.controlPoints.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.meshWarp.gridXPublished scene.layers.options.groupTransform.meshWarp.gridX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.meshWarp.gridYPublished scene.layers.options.groupTransform.meshWarp.gridY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.opacityPublished scene.layers.options.groupTransform.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.pivotXPublished scene.layers.options.groupTransform.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.pivotYPublished scene.layers.options.groupTransform.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.rotationPublished scene.layers.options.groupTransform.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.scaleXPublished scene.layers.options.groupTransform.scaleX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.scaleYPublished scene.layers.options.groupTransform.scaleY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadowPublished scene.layers.options.groupTransform.shadow option. | ShadowOptions | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.blurPublished scene.layers.options.groupTransform.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.borderPositionPublished scene.layers.options.groupTransform.shadow.borderPosition option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.borderRadiusPublished scene.layers.options.groupTransform.shadow.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.colorPublished scene.layers.options.groupTransform.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.gradientPublished scene.layers.options.groupTransform.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.gradient.colorsPublished scene.layers.options.groupTransform.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.gradient.colors.colorPublished scene.layers.options.groupTransform.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.gradient.colors.stopPublished scene.layers.options.groupTransform.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.gradient.endXPublished scene.layers.options.groupTransform.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.gradient.endYPublished scene.layers.options.groupTransform.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.gradient.pivotXPublished scene.layers.options.groupTransform.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.gradient.pivotYPublished scene.layers.options.groupTransform.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.gradient.repeatPublished scene.layers.options.groupTransform.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.gradient.rotatePublished scene.layers.options.groupTransform.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.gradient.startXPublished scene.layers.options.groupTransform.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.gradient.startYPublished scene.layers.options.groupTransform.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.gradient.typePublished scene.layers.options.groupTransform.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.gradient.endRadiusPublished scene.layers.options.groupTransform.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.gradient.startRadiusPublished scene.layers.options.groupTransform.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.gradient.centerXPublished scene.layers.options.groupTransform.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.gradient.centerYPublished scene.layers.options.groupTransform.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.gradient.startAnglePublished scene.layers.options.groupTransform.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.offsetXPublished scene.layers.options.groupTransform.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.offsetYPublished scene.layers.options.groupTransform.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.opacityPublished scene.layers.options.groupTransform.shadow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.shadow.roundedCornersPublished scene.layers.options.groupTransform.shadow.roundedCorners option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.strokePublished scene.layers.options.groupTransform.stroke option. | StrokeOptions | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.blurPublished scene.layers.options.groupTransform.stroke.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.borderPositionPublished scene.layers.options.groupTransform.stroke.borderPosition option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.borderRadiusPublished scene.layers.options.groupTransform.stroke.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.colorPublished scene.layers.options.groupTransform.stroke.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.gradientPublished scene.layers.options.groupTransform.stroke.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.gradient.colorsPublished scene.layers.options.groupTransform.stroke.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.gradient.colors.colorPublished scene.layers.options.groupTransform.stroke.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.gradient.colors.stopPublished scene.layers.options.groupTransform.stroke.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.gradient.endXPublished scene.layers.options.groupTransform.stroke.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.gradient.endYPublished scene.layers.options.groupTransform.stroke.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.gradient.pivotXPublished scene.layers.options.groupTransform.stroke.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.gradient.pivotYPublished scene.layers.options.groupTransform.stroke.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.gradient.repeatPublished scene.layers.options.groupTransform.stroke.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.gradient.rotatePublished scene.layers.options.groupTransform.stroke.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.gradient.startXPublished scene.layers.options.groupTransform.stroke.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.gradient.startYPublished scene.layers.options.groupTransform.stroke.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.gradient.typePublished scene.layers.options.groupTransform.stroke.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.gradient.endRadiusPublished scene.layers.options.groupTransform.stroke.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.gradient.startRadiusPublished scene.layers.options.groupTransform.stroke.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.gradient.centerXPublished scene.layers.options.groupTransform.stroke.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.gradient.centerYPublished scene.layers.options.groupTransform.stroke.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.gradient.startAnglePublished scene.layers.options.groupTransform.stroke.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.opacityPublished scene.layers.options.groupTransform.stroke.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.positionPublished scene.layers.options.groupTransform.stroke.position option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.roundedCornersPublished scene.layers.options.groupTransform.stroke.roundedCorners option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.stylePublished scene.layers.options.groupTransform.stroke.style option. | "solid" | "dashed" | "dotted" | "groove" | "ridge" | "double" | OptionalDefault— | 6 values"solid" "dashed" "dotted" "groove" "ridge" "double" | node22 · node24 · node26 |
scene.layers.options.groupTransform.stroke.widthPublished scene.layers.options.groupTransform.stroke.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.translateXPublished scene.layers.options.groupTransform.translateX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.groupTransform.translateYPublished scene.layers.options.groupTransform.translateY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.options.isGroupedPublished scene.layers.options.isGrouped option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.typePublished scene.layers.type option. | "image" | RequiredDefaultRequired | "image" | node22 · node24 · node26 |
scene.layers.textsPublished scene.layers.texts option. | TextProperties | TextProperties[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.boldPublished scene.layers.texts.bold option.Deprecated | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.texts.colorPublished scene.layers.texts.color option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorationsGrouped line decorations (`underline` / `overline` / `strikethrough`) and optional `bold` / `italic` flags for the canvas font string. Nested keys override the legacy flat fields (see {@link resolveTextDecorations}). | TextDecorations | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.boldPublished scene.layers.texts.decorations.bold option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.texts.decorations.italicPublished scene.layers.texts.decorations.italic option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.texts.decorations.overlinePublished scene.layers.texts.decorations.overline option. | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.overline.colorPublished scene.layers.texts.decorations.overline.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.overline.gradientPublished scene.layers.texts.decorations.overline.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.overline.gradient.colorsPublished scene.layers.texts.decorations.overline.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.decorations.overline.gradient.colors.colorPublished scene.layers.texts.decorations.overline.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.decorations.overline.gradient.colors.stopPublished scene.layers.texts.decorations.overline.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.decorations.overline.gradient.endXPublished scene.layers.texts.decorations.overline.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.overline.gradient.endYPublished scene.layers.texts.decorations.overline.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.overline.gradient.pivotXPublished scene.layers.texts.decorations.overline.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.overline.gradient.pivotYPublished scene.layers.texts.decorations.overline.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.overline.gradient.repeatPublished scene.layers.texts.decorations.overline.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.texts.decorations.overline.gradient.rotatePublished scene.layers.texts.decorations.overline.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.overline.gradient.startXPublished scene.layers.texts.decorations.overline.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.overline.gradient.startYPublished scene.layers.texts.decorations.overline.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.overline.gradient.typePublished scene.layers.texts.decorations.overline.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.texts.decorations.overline.gradient.endRadiusPublished scene.layers.texts.decorations.overline.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.overline.gradient.startRadiusPublished scene.layers.texts.decorations.overline.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.overline.gradient.centerXPublished scene.layers.texts.decorations.overline.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.overline.gradient.centerYPublished scene.layers.texts.decorations.overline.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.overline.gradient.startAnglePublished scene.layers.texts.decorations.overline.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.overline.widthPublished scene.layers.texts.decorations.overline.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethroughPublished scene.layers.texts.decorations.strikethrough option. | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethrough.colorPublished scene.layers.texts.decorations.strikethrough.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethrough.gradientPublished scene.layers.texts.decorations.strikethrough.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethrough.gradient.colorsPublished scene.layers.texts.decorations.strikethrough.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethrough.gradient.colors.colorPublished scene.layers.texts.decorations.strikethrough.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethrough.gradient.colors.stopPublished scene.layers.texts.decorations.strikethrough.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethrough.gradient.endXPublished scene.layers.texts.decorations.strikethrough.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethrough.gradient.endYPublished scene.layers.texts.decorations.strikethrough.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethrough.gradient.pivotXPublished scene.layers.texts.decorations.strikethrough.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethrough.gradient.pivotYPublished scene.layers.texts.decorations.strikethrough.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethrough.gradient.repeatPublished scene.layers.texts.decorations.strikethrough.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethrough.gradient.rotatePublished scene.layers.texts.decorations.strikethrough.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethrough.gradient.startXPublished scene.layers.texts.decorations.strikethrough.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethrough.gradient.startYPublished scene.layers.texts.decorations.strikethrough.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethrough.gradient.typePublished scene.layers.texts.decorations.strikethrough.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethrough.gradient.endRadiusPublished scene.layers.texts.decorations.strikethrough.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethrough.gradient.startRadiusPublished scene.layers.texts.decorations.strikethrough.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethrough.gradient.centerXPublished scene.layers.texts.decorations.strikethrough.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethrough.gradient.centerYPublished scene.layers.texts.decorations.strikethrough.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethrough.gradient.startAnglePublished scene.layers.texts.decorations.strikethrough.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.strikethrough.widthPublished scene.layers.texts.decorations.strikethrough.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.underlinePublished scene.layers.texts.decorations.underline option. | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.underline.colorPublished scene.layers.texts.decorations.underline.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.underline.gradientPublished scene.layers.texts.decorations.underline.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.underline.gradient.colorsPublished scene.layers.texts.decorations.underline.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.decorations.underline.gradient.colors.colorPublished scene.layers.texts.decorations.underline.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.decorations.underline.gradient.colors.stopPublished scene.layers.texts.decorations.underline.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.decorations.underline.gradient.endXPublished scene.layers.texts.decorations.underline.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.underline.gradient.endYPublished scene.layers.texts.decorations.underline.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.underline.gradient.pivotXPublished scene.layers.texts.decorations.underline.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.underline.gradient.pivotYPublished scene.layers.texts.decorations.underline.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.underline.gradient.repeatPublished scene.layers.texts.decorations.underline.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.texts.decorations.underline.gradient.rotatePublished scene.layers.texts.decorations.underline.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.underline.gradient.startXPublished scene.layers.texts.decorations.underline.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.underline.gradient.startYPublished scene.layers.texts.decorations.underline.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.underline.gradient.typePublished scene.layers.texts.decorations.underline.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.texts.decorations.underline.gradient.endRadiusPublished scene.layers.texts.decorations.underline.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.underline.gradient.startRadiusPublished scene.layers.texts.decorations.underline.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.underline.gradient.centerXPublished scene.layers.texts.decorations.underline.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.underline.gradient.centerYPublished scene.layers.texts.decorations.underline.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.underline.gradient.startAnglePublished scene.layers.texts.decorations.underline.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.decorations.underline.widthPublished scene.layers.texts.decorations.underline.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effectsGrouped highlight, glow, and shadow. When set, entries override the legacy flat fields (see {@link resolveTextEffects}). | TextEffects | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.glowPublished scene.layers.texts.effects.glow option. | TextGlowStyle | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.glow.colorPublished scene.layers.texts.effects.glow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.glow.gradientPublished scene.layers.texts.effects.glow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.glow.gradient.colorsPublished scene.layers.texts.effects.glow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.effects.glow.gradient.colors.colorPublished scene.layers.texts.effects.glow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.effects.glow.gradient.colors.stopPublished scene.layers.texts.effects.glow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.effects.glow.gradient.endXPublished scene.layers.texts.effects.glow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.glow.gradient.endYPublished scene.layers.texts.effects.glow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.glow.gradient.pivotXPublished scene.layers.texts.effects.glow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.glow.gradient.pivotYPublished scene.layers.texts.effects.glow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.glow.gradient.repeatPublished scene.layers.texts.effects.glow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.texts.effects.glow.gradient.rotatePublished scene.layers.texts.effects.glow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.glow.gradient.startXPublished scene.layers.texts.effects.glow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.glow.gradient.startYPublished scene.layers.texts.effects.glow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.glow.gradient.typePublished scene.layers.texts.effects.glow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.texts.effects.glow.gradient.endRadiusPublished scene.layers.texts.effects.glow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.glow.gradient.startRadiusPublished scene.layers.texts.effects.glow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.glow.gradient.centerXPublished scene.layers.texts.effects.glow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.glow.gradient.centerYPublished scene.layers.texts.effects.glow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.glow.gradient.startAnglePublished scene.layers.texts.effects.glow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.glow.intensityPublished scene.layers.texts.effects.glow.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.glow.opacityPublished scene.layers.texts.effects.glow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.highlightPublished scene.layers.texts.effects.highlight option. | TextHighlightStyle | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.highlight.colorPublished scene.layers.texts.effects.highlight.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.highlight.gradientPublished scene.layers.texts.effects.highlight.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.highlight.gradient.colorsPublished scene.layers.texts.effects.highlight.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.effects.highlight.gradient.colors.colorPublished scene.layers.texts.effects.highlight.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.effects.highlight.gradient.colors.stopPublished scene.layers.texts.effects.highlight.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.effects.highlight.gradient.endXPublished scene.layers.texts.effects.highlight.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.highlight.gradient.endYPublished scene.layers.texts.effects.highlight.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.highlight.gradient.pivotXPublished scene.layers.texts.effects.highlight.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.highlight.gradient.pivotYPublished scene.layers.texts.effects.highlight.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.highlight.gradient.repeatPublished scene.layers.texts.effects.highlight.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.texts.effects.highlight.gradient.rotatePublished scene.layers.texts.effects.highlight.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.highlight.gradient.startXPublished scene.layers.texts.effects.highlight.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.highlight.gradient.startYPublished scene.layers.texts.effects.highlight.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.highlight.gradient.typePublished scene.layers.texts.effects.highlight.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.texts.effects.highlight.gradient.endRadiusPublished scene.layers.texts.effects.highlight.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.highlight.gradient.startRadiusPublished scene.layers.texts.effects.highlight.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.highlight.gradient.centerXPublished scene.layers.texts.effects.highlight.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.highlight.gradient.centerYPublished scene.layers.texts.effects.highlight.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.highlight.gradient.startAnglePublished scene.layers.texts.effects.highlight.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.highlight.opacityPublished scene.layers.texts.effects.highlight.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadowPublished scene.layers.texts.effects.shadow option. | TextShadowStyle | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.blurPublished scene.layers.texts.effects.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.colorPublished scene.layers.texts.effects.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.gradientPublished scene.layers.texts.effects.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.gradient.colorsPublished scene.layers.texts.effects.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.gradient.colors.colorPublished scene.layers.texts.effects.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.gradient.colors.stopPublished scene.layers.texts.effects.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.gradient.endXPublished scene.layers.texts.effects.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.gradient.endYPublished scene.layers.texts.effects.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.gradient.pivotXPublished scene.layers.texts.effects.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.gradient.pivotYPublished scene.layers.texts.effects.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.gradient.repeatPublished scene.layers.texts.effects.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.gradient.rotatePublished scene.layers.texts.effects.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.gradient.startXPublished scene.layers.texts.effects.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.gradient.startYPublished scene.layers.texts.effects.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.gradient.typePublished scene.layers.texts.effects.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.gradient.endRadiusPublished scene.layers.texts.effects.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.gradient.startRadiusPublished scene.layers.texts.effects.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.gradient.centerXPublished scene.layers.texts.effects.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.gradient.centerYPublished scene.layers.texts.effects.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.gradient.startAnglePublished scene.layers.texts.effects.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.offsetXPublished scene.layers.texts.effects.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.offsetYPublished scene.layers.texts.effects.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.effects.shadow.opacityPublished scene.layers.texts.effects.shadow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fillGrouped fill color / gradient and draw opacity (see {@link resolveTextFill}). | TextFill | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fill.colorPublished scene.layers.texts.fill.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fill.gradientPublished scene.layers.texts.fill.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fill.gradient.colorsPublished scene.layers.texts.fill.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.fill.gradient.colors.colorPublished scene.layers.texts.fill.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.fill.gradient.colors.stopPublished scene.layers.texts.fill.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.fill.gradient.endXPublished scene.layers.texts.fill.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fill.gradient.endYPublished scene.layers.texts.fill.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fill.gradient.pivotXPublished scene.layers.texts.fill.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fill.gradient.pivotYPublished scene.layers.texts.fill.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fill.gradient.repeatPublished scene.layers.texts.fill.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.texts.fill.gradient.rotatePublished scene.layers.texts.fill.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fill.gradient.startXPublished scene.layers.texts.fill.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fill.gradient.startYPublished scene.layers.texts.fill.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fill.gradient.typePublished scene.layers.texts.fill.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.texts.fill.gradient.endRadiusPublished scene.layers.texts.fill.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fill.gradient.startRadiusPublished scene.layers.texts.fill.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fill.gradient.centerXPublished scene.layers.texts.fill.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fill.gradient.centerYPublished scene.layers.texts.fill.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fill.gradient.startAnglePublished scene.layers.texts.fill.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fill.opacityPublished scene.layers.texts.fill.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fontPublished scene.layers.texts.font option. | { size?: number; family?: string; name?: string; path?: string; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.font.familyPublished scene.layers.texts.font.family option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.font.namePublished scene.layers.texts.font.name option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.font.pathPublished scene.layers.texts.font.path option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.font.sizePublished scene.layers.texts.font.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fontFamilyPublished scene.layers.texts.fontFamily option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fontNamePublished scene.layers.texts.fontName option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fontPathPublished scene.layers.texts.fontPath option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.fontSizePublished scene.layers.texts.fontSize option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.glowPublished scene.layers.texts.glow option.Deprecated | TextGlowStyle | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.glow.colorPublished scene.layers.texts.glow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.glow.gradientPublished scene.layers.texts.glow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.glow.gradient.colorsPublished scene.layers.texts.glow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.glow.gradient.colors.colorPublished scene.layers.texts.glow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.glow.gradient.colors.stopPublished scene.layers.texts.glow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.glow.gradient.endXPublished scene.layers.texts.glow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.glow.gradient.endYPublished scene.layers.texts.glow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.glow.gradient.pivotXPublished scene.layers.texts.glow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.glow.gradient.pivotYPublished scene.layers.texts.glow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.glow.gradient.repeatPublished scene.layers.texts.glow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.texts.glow.gradient.rotatePublished scene.layers.texts.glow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.glow.gradient.startXPublished scene.layers.texts.glow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.glow.gradient.startYPublished scene.layers.texts.glow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.glow.gradient.typePublished scene.layers.texts.glow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.texts.glow.gradient.endRadiusPublished scene.layers.texts.glow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.glow.gradient.startRadiusPublished scene.layers.texts.glow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.glow.gradient.centerXPublished scene.layers.texts.glow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.glow.gradient.centerYPublished scene.layers.texts.glow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.glow.gradient.startAnglePublished scene.layers.texts.glow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.glow.intensityPublished scene.layers.texts.glow.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.glow.opacityPublished scene.layers.texts.glow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.gradientPublished scene.layers.texts.gradient option.Deprecated | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.gradient.colorsPublished scene.layers.texts.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.gradient.colors.colorPublished scene.layers.texts.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.gradient.colors.stopPublished scene.layers.texts.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.gradient.endXPublished scene.layers.texts.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.gradient.endYPublished scene.layers.texts.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.gradient.pivotXPublished scene.layers.texts.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.gradient.pivotYPublished scene.layers.texts.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.gradient.repeatPublished scene.layers.texts.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.texts.gradient.rotatePublished scene.layers.texts.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.gradient.startXPublished scene.layers.texts.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.gradient.startYPublished scene.layers.texts.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.gradient.typePublished scene.layers.texts.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.texts.gradient.endRadiusPublished scene.layers.texts.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.gradient.startRadiusPublished scene.layers.texts.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.gradient.centerXPublished scene.layers.texts.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.gradient.centerYPublished scene.layers.texts.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.gradient.startAnglePublished scene.layers.texts.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.highlightPublished scene.layers.texts.highlight option.Deprecated | TextHighlightStyle | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.highlight.colorPublished scene.layers.texts.highlight.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.highlight.gradientPublished scene.layers.texts.highlight.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.highlight.gradient.colorsPublished scene.layers.texts.highlight.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.highlight.gradient.colors.colorPublished scene.layers.texts.highlight.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.highlight.gradient.colors.stopPublished scene.layers.texts.highlight.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.highlight.gradient.endXPublished scene.layers.texts.highlight.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.highlight.gradient.endYPublished scene.layers.texts.highlight.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.highlight.gradient.pivotXPublished scene.layers.texts.highlight.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.highlight.gradient.pivotYPublished scene.layers.texts.highlight.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.highlight.gradient.repeatPublished scene.layers.texts.highlight.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.texts.highlight.gradient.rotatePublished scene.layers.texts.highlight.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.highlight.gradient.startXPublished scene.layers.texts.highlight.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.highlight.gradient.startYPublished scene.layers.texts.highlight.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.highlight.gradient.typePublished scene.layers.texts.highlight.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.texts.highlight.gradient.endRadiusPublished scene.layers.texts.highlight.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.highlight.gradient.startRadiusPublished scene.layers.texts.highlight.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.highlight.gradient.centerXPublished scene.layers.texts.highlight.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.highlight.gradient.centerYPublished scene.layers.texts.highlight.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.highlight.gradient.startAnglePublished scene.layers.texts.highlight.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.highlight.opacityPublished scene.layers.texts.highlight.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.includeCharMetricsPublished scene.layers.texts.includeCharMetrics option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.texts.italicPublished scene.layers.texts.italic option.Deprecated | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.texts.layoutGrouped line height, spacing, and wrap bounds (see {@link resolveTextLayout}). | TextLayout | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.layout.letterSpacingPublished scene.layers.texts.layout.letterSpacing option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.layout.lineHeightPublished scene.layers.texts.layout.lineHeight option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.layout.maxHeightPublished scene.layers.texts.layout.maxHeight option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.layout.maxWidthPublished scene.layers.texts.layout.maxWidth option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.layout.wordSpacingPublished scene.layers.texts.layout.wordSpacing option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.letterSpacingPublished scene.layers.texts.letterSpacing option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.lineHeightPublished scene.layers.texts.lineHeight option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.maxHeightPublished scene.layers.texts.maxHeight option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.maxWidthPublished scene.layers.texts.maxWidth option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.measurementCanvasPublished scene.layers.texts.measurementCanvas option. | { width?: number; height?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.measurementCanvas.heightPublished scene.layers.texts.measurementCanvas.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.measurementCanvas.widthPublished scene.layers.texts.measurementCanvas.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.opacityPublished scene.layers.texts.opacity option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.overlinePublished scene.layers.texts.overline option.Deprecated | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.overline.colorPublished scene.layers.texts.overline.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.overline.gradientPublished scene.layers.texts.overline.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.overline.gradient.colorsPublished scene.layers.texts.overline.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.overline.gradient.colors.colorPublished scene.layers.texts.overline.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.overline.gradient.colors.stopPublished scene.layers.texts.overline.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.overline.gradient.endXPublished scene.layers.texts.overline.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.overline.gradient.endYPublished scene.layers.texts.overline.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.overline.gradient.pivotXPublished scene.layers.texts.overline.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.overline.gradient.pivotYPublished scene.layers.texts.overline.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.overline.gradient.repeatPublished scene.layers.texts.overline.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.texts.overline.gradient.rotatePublished scene.layers.texts.overline.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.overline.gradient.startXPublished scene.layers.texts.overline.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.overline.gradient.startYPublished scene.layers.texts.overline.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.overline.gradient.typePublished scene.layers.texts.overline.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.texts.overline.gradient.endRadiusPublished scene.layers.texts.overline.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.overline.gradient.startRadiusPublished scene.layers.texts.overline.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.overline.gradient.centerXPublished scene.layers.texts.overline.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.overline.gradient.centerYPublished scene.layers.texts.overline.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.overline.gradient.startAnglePublished scene.layers.texts.overline.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.overline.widthPublished scene.layers.texts.overline.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.placementGrouped alignment, baseline, and rotation (see {@link resolveTextPlacement}). | TextPlacement | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.placement.rotationPublished scene.layers.texts.placement.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.placement.textAlignPublished scene.layers.texts.placement.textAlign option. | TextAlignMode | OptionalDefault— | 5 values"center" "left" "right" "start" "end" | node22 · node24 · node26 |
scene.layers.texts.placement.textBaselinePublished scene.layers.texts.placement.textBaseline option. | TextBaselineMode | OptionalDefault— | 6 values"top" "bottom" "alphabetic" "hanging" "ideographic" "middle" | node22 · node24 · node26 |
scene.layers.texts.rotationPublished scene.layers.texts.rotation option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.shadowPublished scene.layers.texts.shadow option.Deprecated | TextShadowStyle | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.shadow.blurPublished scene.layers.texts.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.shadow.colorPublished scene.layers.texts.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.shadow.gradientPublished scene.layers.texts.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.shadow.gradient.colorsPublished scene.layers.texts.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.shadow.gradient.colors.colorPublished scene.layers.texts.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.shadow.gradient.colors.stopPublished scene.layers.texts.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.shadow.gradient.endXPublished scene.layers.texts.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.shadow.gradient.endYPublished scene.layers.texts.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.shadow.gradient.pivotXPublished scene.layers.texts.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.shadow.gradient.pivotYPublished scene.layers.texts.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.shadow.gradient.repeatPublished scene.layers.texts.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.texts.shadow.gradient.rotatePublished scene.layers.texts.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.shadow.gradient.startXPublished scene.layers.texts.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.shadow.gradient.startYPublished scene.layers.texts.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.shadow.gradient.typePublished scene.layers.texts.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.texts.shadow.gradient.endRadiusPublished scene.layers.texts.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.shadow.gradient.startRadiusPublished scene.layers.texts.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.shadow.gradient.centerXPublished scene.layers.texts.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.shadow.gradient.centerYPublished scene.layers.texts.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.shadow.gradient.startAnglePublished scene.layers.texts.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.shadow.offsetXPublished scene.layers.texts.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.shadow.offsetYPublished scene.layers.texts.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.shadow.opacityPublished scene.layers.texts.shadow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.strikethroughPublished scene.layers.texts.strikethrough option.Deprecated | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.strikethrough.colorPublished scene.layers.texts.strikethrough.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.strikethrough.gradientPublished scene.layers.texts.strikethrough.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.strikethrough.gradient.colorsPublished scene.layers.texts.strikethrough.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.strikethrough.gradient.colors.colorPublished scene.layers.texts.strikethrough.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.strikethrough.gradient.colors.stopPublished scene.layers.texts.strikethrough.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.strikethrough.gradient.endXPublished scene.layers.texts.strikethrough.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.strikethrough.gradient.endYPublished scene.layers.texts.strikethrough.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.strikethrough.gradient.pivotXPublished scene.layers.texts.strikethrough.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.strikethrough.gradient.pivotYPublished scene.layers.texts.strikethrough.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.strikethrough.gradient.repeatPublished scene.layers.texts.strikethrough.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.texts.strikethrough.gradient.rotatePublished scene.layers.texts.strikethrough.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.strikethrough.gradient.startXPublished scene.layers.texts.strikethrough.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.strikethrough.gradient.startYPublished scene.layers.texts.strikethrough.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.strikethrough.gradient.typePublished scene.layers.texts.strikethrough.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.texts.strikethrough.gradient.endRadiusPublished scene.layers.texts.strikethrough.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.strikethrough.gradient.startRadiusPublished scene.layers.texts.strikethrough.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.strikethrough.gradient.centerXPublished scene.layers.texts.strikethrough.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.strikethrough.gradient.centerYPublished scene.layers.texts.strikethrough.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.strikethrough.gradient.startAnglePublished scene.layers.texts.strikethrough.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.strikethrough.widthPublished scene.layers.texts.strikethrough.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.strokePublished scene.layers.texts.stroke option. | TextStrokeStyle | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.stroke.colorPublished scene.layers.texts.stroke.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.stroke.gradientPublished scene.layers.texts.stroke.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.stroke.gradient.colorsPublished scene.layers.texts.stroke.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.stroke.gradient.colors.colorPublished scene.layers.texts.stroke.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.stroke.gradient.colors.stopPublished scene.layers.texts.stroke.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.stroke.gradient.endXPublished scene.layers.texts.stroke.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.stroke.gradient.endYPublished scene.layers.texts.stroke.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.stroke.gradient.pivotXPublished scene.layers.texts.stroke.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.stroke.gradient.pivotYPublished scene.layers.texts.stroke.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.stroke.gradient.repeatPublished scene.layers.texts.stroke.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.texts.stroke.gradient.rotatePublished scene.layers.texts.stroke.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.stroke.gradient.startXPublished scene.layers.texts.stroke.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.stroke.gradient.startYPublished scene.layers.texts.stroke.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.stroke.gradient.typePublished scene.layers.texts.stroke.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.texts.stroke.gradient.endRadiusPublished scene.layers.texts.stroke.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.stroke.gradient.startRadiusPublished scene.layers.texts.stroke.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.stroke.gradient.centerXPublished scene.layers.texts.stroke.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.stroke.gradient.centerYPublished scene.layers.texts.stroke.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.stroke.gradient.startAnglePublished scene.layers.texts.stroke.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.stroke.opacityPublished scene.layers.texts.stroke.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.stroke.stylePublished scene.layers.texts.stroke.style option. | "solid" | "dashed" | "dotted" | "groove" | "ridge" | "double" | OptionalDefault— | 6 values"solid" "dashed" "dotted" "groove" "ridge" "double" | node22 · node24 · node26 |
scene.layers.texts.stroke.widthPublished scene.layers.texts.stroke.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.textPublished scene.layers.texts.text option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.textAlignPublished scene.layers.texts.textAlign option.Deprecated | TextAlignMode | OptionalDefault— | 5 values"center" "left" "right" "start" "end" | node22 · node24 · node26 |
scene.layers.texts.textBaselinePublished scene.layers.texts.textBaseline option.Deprecated | TextBaselineMode | OptionalDefault— | 6 values"top" "bottom" "alphabetic" "hanging" "ideographic" "middle" | node22 · node24 · node26 |
scene.layers.texts.textOnCurvePublished scene.layers.texts.textOnCurve option.Deprecated | TextCurveConfig | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.textOnCurve.baselineOffsetPublished scene.layers.texts.textOnCurve.baselineOffset option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.textOnCurve.layoutModePublished scene.layers.texts.textOnCurve.layoutMode option. | CurvedTextLayoutMode | OptionalDefault— | "fit" "clamp" "override" | node22 · node24 · node26 |
scene.layers.texts.textOnCurve.radiusPublished scene.layers.texts.textOnCurve.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.textOnCurve.startAngleDegPublished scene.layers.texts.textOnCurve.startAngleDeg option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.textOnCurve.sweepAnglePublished scene.layers.texts.textOnCurve.sweepAngle option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.textOnCurve.upPublished scene.layers.texts.textOnCurve.up option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.texts.underlinePublished scene.layers.texts.underline option.Deprecated | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.underline.colorPublished scene.layers.texts.underline.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.underline.gradientPublished scene.layers.texts.underline.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.underline.gradient.colorsPublished scene.layers.texts.underline.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.underline.gradient.colors.colorPublished scene.layers.texts.underline.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.underline.gradient.colors.stopPublished scene.layers.texts.underline.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.underline.gradient.endXPublished scene.layers.texts.underline.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.underline.gradient.endYPublished scene.layers.texts.underline.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.underline.gradient.pivotXPublished scene.layers.texts.underline.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.underline.gradient.pivotYPublished scene.layers.texts.underline.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.underline.gradient.repeatPublished scene.layers.texts.underline.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.texts.underline.gradient.rotatePublished scene.layers.texts.underline.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.underline.gradient.startXPublished scene.layers.texts.underline.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.underline.gradient.startYPublished scene.layers.texts.underline.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.underline.gradient.typePublished scene.layers.texts.underline.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.texts.underline.gradient.endRadiusPublished scene.layers.texts.underline.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.underline.gradient.startRadiusPublished scene.layers.texts.underline.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.underline.gradient.centerXPublished scene.layers.texts.underline.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.underline.gradient.centerYPublished scene.layers.texts.underline.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.underline.gradient.startAnglePublished scene.layers.texts.underline.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.underline.widthPublished scene.layers.texts.underline.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.wordSpacingPublished scene.layers.texts.wordSpacing option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.texts.xPublished scene.layers.texts.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.texts.yPublished scene.layers.texts.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.pathPublished scene.layers.path option. | unknown | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.bufferPublished scene.layers.buffer option. | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.globalAlphaPublished scene.layers.globalAlpha option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.globalCompositeOperationPublished scene.layers.globalCompositeOperation option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
scene.layers.heightPublished scene.layers.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.widthPublished scene.layers.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.xPublished scene.layers.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.yPublished scene.layers.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.chartTypePublished scene.layers.chartType option. | SceneChartType | RequiredDefaultRequired | 7 values"pie" "bar" "horizontalBar" "line" "scatter" "radar" "polarArea" | node22 · node24 · node26 |
scene.layers.dataPublished scene.layers.data option. | unknown | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.opacityPublished scene.layers.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.linesPublished scene.layers.lines option. | CustomOptions | CustomOptions[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.lines.arrowPublished scene.layers.lines.arrow option. | { start?: boolean; end?: boolean; size?: number; style?: "filled" | "outline"; color?: string; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.arrow.colorPublished scene.layers.lines.arrow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.arrow.endPublished scene.layers.lines.arrow.end option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.lines.arrow.sizePublished scene.layers.lines.arrow.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.arrow.startPublished scene.layers.lines.arrow.start option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.lines.arrow.stylePublished scene.layers.lines.arrow.style option. | "filled" | "outline" | OptionalDefault— | "filled" "outline" | node22 · node24 · node26 |
scene.layers.lines.endCoordinatesPublished scene.layers.lines.endCoordinates option. | { x: number; y: number; } | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.lines.endCoordinates.xPublished scene.layers.lines.endCoordinates.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.lines.endCoordinates.yPublished scene.layers.lines.endCoordinates.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.lines.lineStylePublished scene.layers.lines.lineStyle option. | { width?: number; color?: string; gradient?: gradient; lineRadius?: string | number; lineJoin?: "round" | "bevel" | "miter"; lineCap?: "square" | "butt" | "round"; singleLine?: boolean; lineDash?: { dashArray?: number[]; offset?: number; }; pattern?: { type: "dots" | "custom" | "dashes"; segments?: number[]; offset?: number; }; texture?: string | Buffer<ArrayBufferLike>; stroke?: { color?: string; gradient?: gradient; width?: number; lineRadius?: string | number; lineCap?: "square" | "butt" | "round"; }; shadow?: { offsetX?: number; offsetY?: number; blur?: number; color?: string; gradient?: gradient; lineRadius?: string | number; }; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.colorPublished scene.layers.lines.lineStyle.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.gradientPublished scene.layers.lines.lineStyle.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.gradient.colorsPublished scene.layers.lines.lineStyle.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.gradient.colors.colorPublished scene.layers.lines.lineStyle.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.gradient.colors.stopPublished scene.layers.lines.lineStyle.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.gradient.endXPublished scene.layers.lines.lineStyle.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.gradient.endYPublished scene.layers.lines.lineStyle.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.gradient.pivotXPublished scene.layers.lines.lineStyle.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.gradient.pivotYPublished scene.layers.lines.lineStyle.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.gradient.repeatPublished scene.layers.lines.lineStyle.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.lines.lineStyle.gradient.rotatePublished scene.layers.lines.lineStyle.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.gradient.startXPublished scene.layers.lines.lineStyle.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.gradient.startYPublished scene.layers.lines.lineStyle.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.gradient.typePublished scene.layers.lines.lineStyle.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.lines.lineStyle.gradient.endRadiusPublished scene.layers.lines.lineStyle.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.gradient.startRadiusPublished scene.layers.lines.lineStyle.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.gradient.centerXPublished scene.layers.lines.lineStyle.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.gradient.centerYPublished scene.layers.lines.lineStyle.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.gradient.startAnglePublished scene.layers.lines.lineStyle.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.lineCapPublished scene.layers.lines.lineStyle.lineCap option. | "square" | "butt" | "round" | OptionalDefault— | "square" "butt" "round" | node22 · node24 · node26 |
scene.layers.lines.lineStyle.lineDashPublished scene.layers.lines.lineStyle.lineDash option. | { dashArray?: number[]; offset?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.lineDash.dashArrayPublished scene.layers.lines.lineStyle.lineDash.dashArray option. | number[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.lineDash.offsetPublished scene.layers.lines.lineStyle.lineDash.offset option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.lineJoinPublished scene.layers.lines.lineStyle.lineJoin option. | "round" | "bevel" | "miter" | OptionalDefault— | "round" "bevel" "miter" | node22 · node24 · node26 |
scene.layers.lines.lineStyle.lineRadiusPublished scene.layers.lines.lineStyle.lineRadius option. | string | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.patternPublished scene.layers.lines.lineStyle.pattern option. | { type: "dots" | "custom" | "dashes"; segments?: number[]; offset?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.pattern.offsetPublished scene.layers.lines.lineStyle.pattern.offset option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.pattern.segmentsPublished scene.layers.lines.lineStyle.pattern.segments option. | number[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.pattern.typePublished scene.layers.lines.lineStyle.pattern.type option. | "dots" | "custom" | "dashes" | RequiredDefaultRequired | "dots" "custom" "dashes" | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadowPublished scene.layers.lines.lineStyle.shadow option. | { offsetX?: number; offsetY?: number; blur?: number; color?: string; gradient?: gradient; lineRadius?: string | number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.blurPublished scene.layers.lines.lineStyle.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.colorPublished scene.layers.lines.lineStyle.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.gradientPublished scene.layers.lines.lineStyle.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.gradient.colorsPublished scene.layers.lines.lineStyle.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.gradient.colors.colorPublished scene.layers.lines.lineStyle.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.gradient.colors.stopPublished scene.layers.lines.lineStyle.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.gradient.endXPublished scene.layers.lines.lineStyle.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.gradient.endYPublished scene.layers.lines.lineStyle.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.gradient.pivotXPublished scene.layers.lines.lineStyle.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.gradient.pivotYPublished scene.layers.lines.lineStyle.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.gradient.repeatPublished scene.layers.lines.lineStyle.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.gradient.rotatePublished scene.layers.lines.lineStyle.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.gradient.startXPublished scene.layers.lines.lineStyle.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.gradient.startYPublished scene.layers.lines.lineStyle.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.gradient.typePublished scene.layers.lines.lineStyle.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.gradient.endRadiusPublished scene.layers.lines.lineStyle.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.gradient.startRadiusPublished scene.layers.lines.lineStyle.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.gradient.centerXPublished scene.layers.lines.lineStyle.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.gradient.centerYPublished scene.layers.lines.lineStyle.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.gradient.startAnglePublished scene.layers.lines.lineStyle.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.lineRadiusPublished scene.layers.lines.lineStyle.shadow.lineRadius option. | string | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.offsetXPublished scene.layers.lines.lineStyle.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.shadow.offsetYPublished scene.layers.lines.lineStyle.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.singleLinePublished scene.layers.lines.lineStyle.singleLine option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.lines.lineStyle.strokePublished scene.layers.lines.lineStyle.stroke option. | { color?: string; gradient?: gradient; width?: number; lineRadius?: string | number; lineCap?: "square" | "butt" | "round"; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.colorPublished scene.layers.lines.lineStyle.stroke.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.gradientPublished scene.layers.lines.lineStyle.stroke.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.gradient.colorsPublished scene.layers.lines.lineStyle.stroke.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.gradient.colors.colorPublished scene.layers.lines.lineStyle.stroke.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.gradient.colors.stopPublished scene.layers.lines.lineStyle.stroke.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.gradient.endXPublished scene.layers.lines.lineStyle.stroke.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.gradient.endYPublished scene.layers.lines.lineStyle.stroke.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.gradient.pivotXPublished scene.layers.lines.lineStyle.stroke.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.gradient.pivotYPublished scene.layers.lines.lineStyle.stroke.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.gradient.repeatPublished scene.layers.lines.lineStyle.stroke.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.gradient.rotatePublished scene.layers.lines.lineStyle.stroke.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.gradient.startXPublished scene.layers.lines.lineStyle.stroke.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.gradient.startYPublished scene.layers.lines.lineStyle.stroke.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.gradient.typePublished scene.layers.lines.lineStyle.stroke.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.gradient.endRadiusPublished scene.layers.lines.lineStyle.stroke.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.gradient.startRadiusPublished scene.layers.lines.lineStyle.stroke.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.gradient.centerXPublished scene.layers.lines.lineStyle.stroke.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.gradient.centerYPublished scene.layers.lines.lineStyle.stroke.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.gradient.startAnglePublished scene.layers.lines.lineStyle.stroke.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.lineCapPublished scene.layers.lines.lineStyle.stroke.lineCap option. | "square" | "butt" | "round" | OptionalDefault— | "square" "butt" "round" | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.lineRadiusPublished scene.layers.lines.lineStyle.stroke.lineRadius option. | string | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.stroke.widthPublished scene.layers.lines.lineStyle.stroke.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.texturePublished scene.layers.lines.lineStyle.texture option. | string | Buffer<ArrayBufferLike> | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.lineStyle.widthPublished scene.layers.lines.lineStyle.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.markersPublished scene.layers.lines.markers option. | { position: number; shape: "square" | "circle" | "diamond" | "arrow"; size: number; color: string; }[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.markers.colorPublished scene.layers.lines.markers.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.lines.markers.positionPublished scene.layers.lines.markers.position option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.lines.markers.shapePublished scene.layers.lines.markers.shape option. | "square" | "circle" | "diamond" | "arrow" | RequiredDefaultRequired | "square" "circle" "diamond" "arrow" | node22 · node24 · node26 |
scene.layers.lines.markers.sizePublished scene.layers.lines.markers.size option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.lines.pathPublished scene.layers.lines.path option. | { type: "bezier" | "smooth" | "catmull-rom"; tension?: number; closed?: boolean; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.path.closedPublished scene.layers.lines.path.closed option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.lines.path.tensionPublished scene.layers.lines.path.tension option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.lines.path.typePublished scene.layers.lines.path.type option. | "bezier" | "smooth" | "catmull-rom" | RequiredDefaultRequired | "bezier" "smooth" "catmull-rom" | node22 · node24 · node26 |
scene.layers.lines.startCoordinatesPublished scene.layers.lines.startCoordinates option. | { x: number; y: number; } | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.lines.startCoordinates.xPublished scene.layers.lines.startCoordinates.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.lines.startCoordinates.yPublished scene.layers.lines.startCoordinates.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.backgroundChild background paint only; dimensions are always taken from `placement`. | SceneBackground | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayersPublished scene.layers.background.bgLayers option. | BackgroundLayer[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.blendModePublished scene.layers.background.bgLayers.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
scene.layers.background.bgLayers.opacityPublished scene.layers.background.bgLayers.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.typePublished scene.layers.background.bgLayers.type option. | "color" | RequiredDefaultRequired | "color" | node22 · node24 · node26 |
scene.layers.background.bgLayers.valuePublished scene.layers.background.bgLayers.value option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.alignPublished scene.layers.background.bgLayers.align option. | AlignMode | OptionalDefault— | 9 values"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" | node22 · node24 · node26 |
scene.layers.background.bgLayers.fitPublished scene.layers.background.bgLayers.fit option. | "fill" | "contain" | "cover" | OptionalDefault— | "fill" "contain" "cover" | node22 · node24 · node26 |
scene.layers.background.bgLayers.sourcePublished scene.layers.background.bgLayers.source option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.repeatPublished scene.layers.background.bgLayers.repeat option. | BackgroundPatternRepeat | OptionalDefault— | "repeat" "no-repeat" "repeat-x" "repeat-y" | node22 · node24 · node26 |
scene.layers.background.bgLayers.patternPublished scene.layers.background.bgLayers.pattern option. | PatternOptions | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.blendModePublished scene.layers.background.bgLayers.pattern.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.colorPublished scene.layers.background.bgLayers.pattern.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.customPatternImagePublished scene.layers.background.bgLayers.pattern.customPatternImage option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.gradientPublished scene.layers.background.bgLayers.pattern.gradient option. | GradientConfig | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.gradient.anglePublished scene.layers.background.bgLayers.pattern.gradient.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.gradient.centerXPublished scene.layers.background.bgLayers.pattern.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.gradient.centerYPublished scene.layers.background.bgLayers.pattern.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.gradient.colorsPublished scene.layers.background.bgLayers.pattern.gradient.colors option. | { stop: number; color: string; }[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.gradient.colors.colorPublished scene.layers.background.bgLayers.pattern.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.gradient.colors.stopPublished scene.layers.background.bgLayers.pattern.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.gradient.endRadiusPublished scene.layers.background.bgLayers.pattern.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.gradient.endXPublished scene.layers.background.bgLayers.pattern.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.gradient.endYPublished scene.layers.background.bgLayers.pattern.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.gradient.repeatPublished scene.layers.background.bgLayers.pattern.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.gradient.startAnglePublished scene.layers.background.bgLayers.pattern.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.gradient.startRadiusPublished scene.layers.background.bgLayers.pattern.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.gradient.startXPublished scene.layers.background.bgLayers.pattern.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.gradient.startYPublished scene.layers.background.bgLayers.pattern.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.gradient.typePublished scene.layers.background.bgLayers.pattern.gradient.type option. | "linear" | "radial" | "conic" | RequiredDefaultRequired | "linear" "radial" "conic" | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.offsetXPublished scene.layers.background.bgLayers.pattern.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.offsetYPublished scene.layers.background.bgLayers.pattern.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.opacityPublished scene.layers.background.bgLayers.pattern.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.repeatPublished scene.layers.background.bgLayers.pattern.repeat option. | "repeat" | "no-repeat" | "repeat-x" | "repeat-y" | OptionalDefault— | "repeat" "no-repeat" "repeat-x" "repeat-y" | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.rotationPublished scene.layers.background.bgLayers.pattern.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.scalePublished scene.layers.background.bgLayers.pattern.scale option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.secondaryColorPublished scene.layers.background.bgLayers.pattern.secondaryColor option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.sizePublished scene.layers.background.bgLayers.pattern.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.spacingPublished scene.layers.background.bgLayers.pattern.spacing option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.bgLayers.pattern.typePublished scene.layers.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 |
scene.layers.background.bgLayers.intensityPublished scene.layers.background.bgLayers.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.blendModePublished scene.layers.background.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
scene.layers.background.blurPublished scene.layers.background.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.borderPositionPublished scene.layers.background.borderPosition option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.borderRadiusPublished scene.layers.background.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.colorBgPublished scene.layers.background.colorBg option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.customBgPublished scene.layers.background.customBg option. | CanvasCustomBackground | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.customBg.alignPlacement used by `contain` / `cover` when `inherit` is false. | AlignMode | OptionalDefault— | 9 values"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" | node22 · node24 · node26 |
scene.layers.background.customBg.filtersImage filters applied to this background only. | ImageFilter[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.customBg.filters.anglePublished scene.layers.background.customBg.filters.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.customBg.filters.centerXPublished scene.layers.background.customBg.filters.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.customBg.filters.centerYPublished scene.layers.background.customBg.filters.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.customBg.filters.heightPublished scene.layers.background.customBg.filters.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.customBg.filters.intensityPublished scene.layers.background.customBg.filters.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.customBg.filters.levelsPublished scene.layers.background.customBg.filters.levels option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.customBg.filters.radiusPublished scene.layers.background.customBg.filters.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.customBg.filters.sizePublished scene.layers.background.customBg.filters.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.customBg.filters.typePublished scene.layers.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 |
scene.layers.background.customBg.filters.valuePublished scene.layers.background.customBg.filters.value option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.customBg.filters.widthPublished scene.layers.background.customBg.filters.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.customBg.filters.xOptional pixelate region. Omit for the whole filtered surface. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.customBg.filters.yPublished scene.layers.background.customBg.filters.y option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.customBg.fitResize policy when `inherit` is false. | FitMode | OptionalDefault— | "fill" "contain" "cover" | node22 · node24 · node26 |
scene.layers.background.customBg.inheritAdopt the source image dimensions as the canvas dimensions. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.background.customBg.opacityBackground-image opacity, multiplied by the canvas-level opacity. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.customBg.sourcePublished scene.layers.background.customBg.source option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.background.gradientBgPublished scene.layers.background.gradientBg option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.gradientBg.colorsPublished scene.layers.background.gradientBg.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.background.gradientBg.colors.colorPublished scene.layers.background.gradientBg.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.background.gradientBg.colors.stopPublished scene.layers.background.gradientBg.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.background.gradientBg.endXPublished scene.layers.background.gradientBg.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.gradientBg.endYPublished scene.layers.background.gradientBg.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.gradientBg.pivotXPublished scene.layers.background.gradientBg.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.gradientBg.pivotYPublished scene.layers.background.gradientBg.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.gradientBg.repeatPublished scene.layers.background.gradientBg.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.background.gradientBg.rotatePublished scene.layers.background.gradientBg.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.gradientBg.startXPublished scene.layers.background.gradientBg.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.gradientBg.startYPublished scene.layers.background.gradientBg.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.gradientBg.typePublished scene.layers.background.gradientBg.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.background.gradientBg.endRadiusPublished scene.layers.background.gradientBg.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.gradientBg.startRadiusPublished scene.layers.background.gradientBg.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.gradientBg.centerXPublished scene.layers.background.gradientBg.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.gradientBg.centerYPublished scene.layers.background.gradientBg.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.gradientBg.startAnglePublished scene.layers.background.gradientBg.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.noiseBgPublished scene.layers.background.noiseBg option. | { intensity?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.noiseBg.intensityPublished scene.layers.background.noiseBg.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.opacityPublished scene.layers.background.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBgPublished scene.layers.background.patternBg option. | PatternOptions | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.blendModePublished scene.layers.background.patternBg.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
scene.layers.background.patternBg.colorPublished scene.layers.background.patternBg.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.customPatternImagePublished scene.layers.background.patternBg.customPatternImage option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.gradientPublished scene.layers.background.patternBg.gradient option. | GradientConfig | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.gradient.anglePublished scene.layers.background.patternBg.gradient.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.gradient.centerXPublished scene.layers.background.patternBg.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.gradient.centerYPublished scene.layers.background.patternBg.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.gradient.colorsPublished scene.layers.background.patternBg.gradient.colors option. | { stop: number; color: string; }[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.background.patternBg.gradient.colors.colorPublished scene.layers.background.patternBg.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.background.patternBg.gradient.colors.stopPublished scene.layers.background.patternBg.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.background.patternBg.gradient.endRadiusPublished scene.layers.background.patternBg.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.gradient.endXPublished scene.layers.background.patternBg.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.gradient.endYPublished scene.layers.background.patternBg.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.gradient.repeatPublished scene.layers.background.patternBg.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.background.patternBg.gradient.startAnglePublished scene.layers.background.patternBg.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.gradient.startRadiusPublished scene.layers.background.patternBg.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.gradient.startXPublished scene.layers.background.patternBg.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.gradient.startYPublished scene.layers.background.patternBg.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.gradient.typePublished scene.layers.background.patternBg.gradient.type option. | "linear" | "radial" | "conic" | RequiredDefaultRequired | "linear" "radial" "conic" | node22 · node24 · node26 |
scene.layers.background.patternBg.offsetXPublished scene.layers.background.patternBg.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.offsetYPublished scene.layers.background.patternBg.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.opacityPublished scene.layers.background.patternBg.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.repeatPublished scene.layers.background.patternBg.repeat option. | "repeat" | "no-repeat" | "repeat-x" | "repeat-y" | OptionalDefault— | "repeat" "no-repeat" "repeat-x" "repeat-y" | node22 · node24 · node26 |
scene.layers.background.patternBg.rotationPublished scene.layers.background.patternBg.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.scalePublished scene.layers.background.patternBg.scale option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.secondaryColorPublished scene.layers.background.patternBg.secondaryColor option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.sizePublished scene.layers.background.patternBg.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.spacingPublished scene.layers.background.patternBg.spacing option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.patternBg.typePublished scene.layers.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 |
scene.layers.background.rotationPublished scene.layers.background.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadowPublished scene.layers.background.shadow option. | ShadowOptions | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.blurPublished scene.layers.background.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.borderPositionPublished scene.layers.background.shadow.borderPosition option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.borderRadiusPublished scene.layers.background.shadow.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.colorPublished scene.layers.background.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.gradientPublished scene.layers.background.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.gradient.colorsPublished scene.layers.background.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.background.shadow.gradient.colors.colorPublished scene.layers.background.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.background.shadow.gradient.colors.stopPublished scene.layers.background.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.background.shadow.gradient.endXPublished scene.layers.background.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.gradient.endYPublished scene.layers.background.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.gradient.pivotXPublished scene.layers.background.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.gradient.pivotYPublished scene.layers.background.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.gradient.repeatPublished scene.layers.background.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.background.shadow.gradient.rotatePublished scene.layers.background.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.gradient.startXPublished scene.layers.background.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.gradient.startYPublished scene.layers.background.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.gradient.typePublished scene.layers.background.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.background.shadow.gradient.endRadiusPublished scene.layers.background.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.gradient.startRadiusPublished scene.layers.background.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.gradient.centerXPublished scene.layers.background.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.gradient.centerYPublished scene.layers.background.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.gradient.startAnglePublished scene.layers.background.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.offsetXPublished scene.layers.background.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.offsetYPublished scene.layers.background.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.opacityPublished scene.layers.background.shadow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.shadow.roundedCornersPublished scene.layers.background.shadow.roundedCorners option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.strokePublished scene.layers.background.stroke option. | StrokeOptions | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.blurPublished scene.layers.background.stroke.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.borderPositionPublished scene.layers.background.stroke.borderPosition option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.borderRadiusPublished scene.layers.background.stroke.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.colorPublished scene.layers.background.stroke.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.gradientPublished scene.layers.background.stroke.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.gradient.colorsPublished scene.layers.background.stroke.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.background.stroke.gradient.colors.colorPublished scene.layers.background.stroke.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.background.stroke.gradient.colors.stopPublished scene.layers.background.stroke.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.background.stroke.gradient.endXPublished scene.layers.background.stroke.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.gradient.endYPublished scene.layers.background.stroke.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.gradient.pivotXPublished scene.layers.background.stroke.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.gradient.pivotYPublished scene.layers.background.stroke.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.gradient.repeatPublished scene.layers.background.stroke.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.background.stroke.gradient.rotatePublished scene.layers.background.stroke.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.gradient.startXPublished scene.layers.background.stroke.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.gradient.startYPublished scene.layers.background.stroke.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.gradient.typePublished scene.layers.background.stroke.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.background.stroke.gradient.endRadiusPublished scene.layers.background.stroke.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.gradient.startRadiusPublished scene.layers.background.stroke.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.gradient.centerXPublished scene.layers.background.stroke.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.gradient.centerYPublished scene.layers.background.stroke.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.gradient.startAnglePublished scene.layers.background.stroke.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.opacityPublished scene.layers.background.stroke.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.positionPublished scene.layers.background.stroke.position option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.roundedCornersPublished scene.layers.background.stroke.roundedCorners option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.stroke.stylePublished scene.layers.background.stroke.style option. | "solid" | "dashed" | "dotted" | "groove" | "ridge" | "double" | OptionalDefault— | 6 values"solid" "dashed" "dotted" "groove" "ridge" "double" | node22 · node24 · node26 |
scene.layers.background.stroke.widthPublished scene.layers.background.stroke.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.transparentBasePublished scene.layers.background.transparentBase option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.background.videoBgPublished scene.layers.background.videoBg option. | CanvasVideoBackground | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.videoBg.alignPlacement used by `contain` / `cover` when `inherit` is false. | AlignMode | OptionalDefault— | 9 values"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" | node22 · node24 · node26 |
scene.layers.background.videoBg.autoplayPublished scene.layers.background.videoBg.autoplay option.Deprecated | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.background.videoBg.filtersImage filters applied to this background only. | ImageFilter[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.videoBg.filters.anglePublished scene.layers.background.videoBg.filters.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.videoBg.filters.centerXPublished scene.layers.background.videoBg.filters.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.videoBg.filters.centerYPublished scene.layers.background.videoBg.filters.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.videoBg.filters.heightPublished scene.layers.background.videoBg.filters.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.videoBg.filters.intensityPublished scene.layers.background.videoBg.filters.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.videoBg.filters.levelsPublished scene.layers.background.videoBg.filters.levels option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.videoBg.filters.radiusPublished scene.layers.background.videoBg.filters.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.videoBg.filters.sizePublished scene.layers.background.videoBg.filters.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.videoBg.filters.typePublished scene.layers.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 |
scene.layers.background.videoBg.filters.valuePublished scene.layers.background.videoBg.filters.value option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.videoBg.filters.widthPublished scene.layers.background.videoBg.filters.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.videoBg.filters.xOptional pixelate region. Omit for the whole filtered surface. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.videoBg.filters.yPublished scene.layers.background.videoBg.filters.y option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.videoBg.fitResize policy when `inherit` is false. | FitMode | OptionalDefault— | "fill" "contain" "cover" | node22 · node24 · node26 |
scene.layers.background.videoBg.formatPublished scene.layers.background.videoBg.format option. | "jpg" | "png" | OptionalDefault— | "jpg" "png" | node22 · node24 · node26 |
scene.layers.background.videoBg.frame1-based frame number. Mutually exclusive with `time`. Defaults to frame 1 when neither selector is provided. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.videoBg.inheritAdopt the source image dimensions as the canvas dimensions. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.background.videoBg.loopPublished scene.layers.background.videoBg.loop option.Deprecated | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.background.videoBg.opacityBackground-image opacity, multiplied by the canvas-level opacity. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.videoBg.qualityFFmpeg image quality value from 1 (best) through 31. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.videoBg.sourcePublished scene.layers.background.videoBg.source option. | string | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.background.videoBg.timeTimestamp in seconds. Mutually exclusive with `frame`. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.xPublished scene.layers.background.x option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.yPublished scene.layers.background.y option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.zoomPublished scene.layers.background.zoom option. | { scale?: number; centerX?: number; centerY?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.zoom.centerXPublished scene.layers.background.zoom.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.zoom.centerYPublished scene.layers.background.zoom.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.background.zoom.scalePublished scene.layers.background.zoom.scale option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layersChild layers are clipped to the child surface canvas before parent transforms/opacity are applied. | SceneLayer[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.imagesPublished scene.layers.layers.images option. | ImageProperties | ImageProperties[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.alignPublished scene.layers.layers.images.align option. | AlignMode | OptionalDefault— | 9 values"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" | node22 · node24 · node26 |
scene.layers.layers.images.blendModePublished scene.layers.layers.images.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
scene.layers.layers.images.blurPublished scene.layers.layers.images.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.borderPositionPublished scene.layers.layers.images.borderPosition option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.borderRadiusPublished scene.layers.layers.images.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.boxBackgroundPublished scene.layers.layers.images.boxBackground option. | BoxBackground | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.boxBackground.colorPublished scene.layers.layers.images.boxBackground.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.boxBackground.gradientPublished scene.layers.layers.images.boxBackground.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.boxBackground.gradient.colorsPublished scene.layers.layers.images.boxBackground.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.boxBackground.gradient.colors.colorPublished scene.layers.layers.images.boxBackground.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.boxBackground.gradient.colors.stopPublished scene.layers.layers.images.boxBackground.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.boxBackground.gradient.endXPublished scene.layers.layers.images.boxBackground.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.boxBackground.gradient.endYPublished scene.layers.layers.images.boxBackground.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.boxBackground.gradient.pivotXPublished scene.layers.layers.images.boxBackground.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.boxBackground.gradient.pivotYPublished scene.layers.layers.images.boxBackground.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.boxBackground.gradient.repeatPublished scene.layers.layers.images.boxBackground.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.images.boxBackground.gradient.rotatePublished scene.layers.layers.images.boxBackground.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.boxBackground.gradient.startXPublished scene.layers.layers.images.boxBackground.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.boxBackground.gradient.startYPublished scene.layers.layers.images.boxBackground.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.boxBackground.gradient.typePublished scene.layers.layers.images.boxBackground.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.images.boxBackground.gradient.endRadiusPublished scene.layers.layers.images.boxBackground.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.boxBackground.gradient.startRadiusPublished scene.layers.layers.images.boxBackground.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.boxBackground.gradient.centerXPublished scene.layers.layers.images.boxBackground.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.boxBackground.gradient.centerYPublished scene.layers.layers.images.boxBackground.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.boxBackground.gradient.startAnglePublished scene.layers.layers.images.boxBackground.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.clipPathPublished scene.layers.layers.images.clipPath option. | { x: number; y: number; }[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.clipPath.xPublished scene.layers.layers.images.clipPath.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.clipPath.yPublished scene.layers.layers.images.clipPath.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.distortionPublished scene.layers.layers.images.distortion option. | { type: "perspective" | "warp" | "bulge" | "pinch"; points?: { x: number; y: number; }[]; intensity?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.distortion.intensityPublished scene.layers.layers.images.distortion.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.distortion.pointsPublished scene.layers.layers.images.distortion.points option. | { x: number; y: number; }[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.distortion.points.xPublished scene.layers.layers.images.distortion.points.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.distortion.points.yPublished scene.layers.layers.images.distortion.points.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.distortion.typePublished scene.layers.layers.images.distortion.type option. | "perspective" | "warp" | "bulge" | "pinch" | RequiredDefaultRequired | "perspective" "warp" "bulge" "pinch" | node22 · node24 · node26 |
scene.layers.layers.images.effectsPublished scene.layers.layers.images.effects option. | { vignette?: { intensity: number; size: number; }; lensFlare?: { x: number; y: number; intensity: number; }; chromaticAberration?: { intensity: number; }; filmGrain?: { intensity: number; }; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.effects.chromaticAberrationPublished scene.layers.layers.images.effects.chromaticAberration option. | { intensity: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.effects.chromaticAberration.intensityPublished scene.layers.layers.images.effects.chromaticAberration.intensity option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.effects.filmGrainPublished scene.layers.layers.images.effects.filmGrain option. | { intensity: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.effects.filmGrain.intensityPublished scene.layers.layers.images.effects.filmGrain.intensity option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.effects.lensFlarePublished scene.layers.layers.images.effects.lensFlare option. | { x: number; y: number; intensity: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.effects.lensFlare.intensityPublished scene.layers.layers.images.effects.lensFlare.intensity option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.effects.lensFlare.xPublished scene.layers.layers.images.effects.lensFlare.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.effects.lensFlare.yPublished scene.layers.layers.images.effects.lensFlare.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.effects.vignettePublished scene.layers.layers.images.effects.vignette option. | { intensity: number; size: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.effects.vignette.intensityPublished scene.layers.layers.images.effects.vignette.intensity option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.effects.vignette.sizePublished scene.layers.layers.images.effects.vignette.size option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.filterIntensityPublished scene.layers.layers.images.filterIntensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.filterOrderPublished scene.layers.layers.images.filterOrder option. | "pre" | "post" | OptionalDefault— | "pre" "post" | node22 · node24 · node26 |
scene.layers.layers.images.filtersPublished scene.layers.layers.images.filters option. | ImageFilter[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.filters.anglePublished scene.layers.layers.images.filters.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.filters.centerXPublished scene.layers.layers.images.filters.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.filters.centerYPublished scene.layers.layers.images.filters.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.filters.heightPublished scene.layers.layers.images.filters.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.filters.intensityPublished scene.layers.layers.images.filters.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.filters.levelsPublished scene.layers.layers.images.filters.levels option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.filters.radiusPublished scene.layers.layers.images.filters.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.filters.sizePublished scene.layers.layers.images.filters.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.filters.typePublished scene.layers.layers.images.filters.type option. | "saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize" | RequiredDefaultRequired | 17 values"saturation" "gaussianBlur" "motionBlur" "radialBlur" "sharpen" "noise" "grain" "edgeDetection" "emboss" "invert" "grayscale" "sepia" "pixelate" "brightness" "contrast" "hueShift" "posterize" | node22 · node24 · node26 |
scene.layers.layers.images.filters.valuePublished scene.layers.layers.images.filters.value option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.filters.widthPublished scene.layers.layers.images.filters.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.filters.xOptional pixelate region. Omit for the whole filtered surface. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.filters.yPublished scene.layers.layers.images.filters.y option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.fitPublished scene.layers.layers.images.fit option. | FitMode | OptionalDefault— | "fill" "contain" "cover" | node22 · node24 · node26 |
scene.layers.layers.images.heightPublished scene.layers.layers.images.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.inheritPublished scene.layers.layers.images.inherit option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.layers.images.maskPublished scene.layers.layers.images.mask option. | { source: string | Buffer<ArrayBufferLike>; mode?: "alpha" | "luminance" | "inverse"; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.mask.modePublished scene.layers.layers.images.mask.mode option. | "alpha" | "luminance" | "inverse" | OptionalDefault— | "alpha" "luminance" "inverse" | node22 · node24 · node26 |
scene.layers.layers.images.mask.sourcePublished scene.layers.layers.images.mask.source option. | string | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.meshWarpPublished scene.layers.layers.images.meshWarp option. | { gridX?: number; gridY?: number; controlPoints?: { x: number; y: number; }[][]; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.meshWarp.controlPointsPublished scene.layers.layers.images.meshWarp.controlPoints option. | { x: number; y: number; }[][] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.meshWarp.controlPoints.xPublished scene.layers.layers.images.meshWarp.controlPoints.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.meshWarp.controlPoints.yPublished scene.layers.layers.images.meshWarp.controlPoints.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.meshWarp.gridXPublished scene.layers.layers.images.meshWarp.gridX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.meshWarp.gridYPublished scene.layers.layers.images.meshWarp.gridY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.opacityPublished scene.layers.layers.images.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.rotationPublished scene.layers.layers.images.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadowPublished scene.layers.layers.images.shadow option. | ShadowOptions | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.blurPublished scene.layers.layers.images.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.borderPositionPublished scene.layers.layers.images.shadow.borderPosition option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.borderRadiusPublished scene.layers.layers.images.shadow.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.colorPublished scene.layers.layers.images.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.gradientPublished scene.layers.layers.images.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.gradient.colorsPublished scene.layers.layers.images.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.gradient.colors.colorPublished scene.layers.layers.images.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.gradient.colors.stopPublished scene.layers.layers.images.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.gradient.endXPublished scene.layers.layers.images.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.gradient.endYPublished scene.layers.layers.images.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.gradient.pivotXPublished scene.layers.layers.images.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.gradient.pivotYPublished scene.layers.layers.images.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.gradient.repeatPublished scene.layers.layers.images.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.images.shadow.gradient.rotatePublished scene.layers.layers.images.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.gradient.startXPublished scene.layers.layers.images.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.gradient.startYPublished scene.layers.layers.images.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.gradient.typePublished scene.layers.layers.images.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.images.shadow.gradient.endRadiusPublished scene.layers.layers.images.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.gradient.startRadiusPublished scene.layers.layers.images.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.gradient.centerXPublished scene.layers.layers.images.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.gradient.centerYPublished scene.layers.layers.images.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.gradient.startAnglePublished scene.layers.layers.images.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.offsetXPublished scene.layers.layers.images.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.offsetYPublished scene.layers.layers.images.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.opacityPublished scene.layers.layers.images.shadow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shadow.roundedCornersPublished scene.layers.layers.images.shadow.roundedCorners option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shapePublished scene.layers.layers.images.shape option. | ShapeProperties | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.centerXPublished scene.layers.layers.images.shape.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.centerYPublished scene.layers.layers.images.shape.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.colorPublished scene.layers.layers.images.shape.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.endAnglePublished scene.layers.layers.images.shape.endAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.fillPublished scene.layers.layers.images.shape.fill option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.layers.images.shape.gradientPublished scene.layers.layers.images.shape.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.gradient.colorsPublished scene.layers.layers.images.shape.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.gradient.colors.colorPublished scene.layers.layers.images.shape.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.gradient.colors.stopPublished scene.layers.layers.images.shape.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.gradient.endXPublished scene.layers.layers.images.shape.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.gradient.endYPublished scene.layers.layers.images.shape.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.gradient.pivotXPublished scene.layers.layers.images.shape.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.gradient.pivotYPublished scene.layers.layers.images.shape.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.gradient.repeatPublished scene.layers.layers.images.shape.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.images.shape.gradient.rotatePublished scene.layers.layers.images.shape.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.gradient.startXPublished scene.layers.layers.images.shape.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.gradient.startYPublished scene.layers.layers.images.shape.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.gradient.typePublished scene.layers.layers.images.shape.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.images.shape.gradient.endRadiusPublished scene.layers.layers.images.shape.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.gradient.startRadiusPublished scene.layers.layers.images.shape.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.gradient.centerXPublished scene.layers.layers.images.shape.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.gradient.centerYPublished scene.layers.layers.images.shape.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.gradient.startAnglePublished scene.layers.layers.images.shape.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.innerRadiusPublished scene.layers.layers.images.shape.innerRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.outerRadiusPublished scene.layers.layers.images.shape.outerRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.pointsPublished scene.layers.layers.images.shape.points option. | { x: number; y: number; }[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.points.xPublished scene.layers.layers.images.shape.points.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.points.yPublished scene.layers.layers.images.shape.points.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.radiusPublished scene.layers.layers.images.shape.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.sidesPublished scene.layers.layers.images.shape.sides option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.shape.startAnglePublished scene.layers.layers.images.shape.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.sourcePublished scene.layers.layers.images.source option. | string | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.strokePublished scene.layers.layers.images.stroke option. | StrokeOptions | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.blurPublished scene.layers.layers.images.stroke.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.borderPositionPublished scene.layers.layers.images.stroke.borderPosition option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.borderRadiusPublished scene.layers.layers.images.stroke.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.colorPublished scene.layers.layers.images.stroke.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.gradientPublished scene.layers.layers.images.stroke.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.gradient.colorsPublished scene.layers.layers.images.stroke.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.gradient.colors.colorPublished scene.layers.layers.images.stroke.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.gradient.colors.stopPublished scene.layers.layers.images.stroke.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.gradient.endXPublished scene.layers.layers.images.stroke.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.gradient.endYPublished scene.layers.layers.images.stroke.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.gradient.pivotXPublished scene.layers.layers.images.stroke.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.gradient.pivotYPublished scene.layers.layers.images.stroke.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.gradient.repeatPublished scene.layers.layers.images.stroke.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.images.stroke.gradient.rotatePublished scene.layers.layers.images.stroke.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.gradient.startXPublished scene.layers.layers.images.stroke.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.gradient.startYPublished scene.layers.layers.images.stroke.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.gradient.typePublished scene.layers.layers.images.stroke.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.images.stroke.gradient.endRadiusPublished scene.layers.layers.images.stroke.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.gradient.startRadiusPublished scene.layers.layers.images.stroke.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.gradient.centerXPublished scene.layers.layers.images.stroke.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.gradient.centerYPublished scene.layers.layers.images.stroke.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.gradient.startAnglePublished scene.layers.layers.images.stroke.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.opacityPublished scene.layers.layers.images.stroke.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.positionPublished scene.layers.layers.images.stroke.position option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.roundedCornersPublished scene.layers.layers.images.stroke.roundedCorners option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.stroke.stylePublished scene.layers.layers.images.stroke.style option. | "solid" | "dashed" | "dotted" | "groove" | "ridge" | "double" | OptionalDefault— | 6 values"solid" "dashed" "dotted" "groove" "ridge" "double" | node22 · node24 · node26 |
scene.layers.layers.images.stroke.widthPublished scene.layers.layers.images.stroke.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.widthPublished scene.layers.layers.images.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.images.xPublished scene.layers.layers.images.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.images.yPublished scene.layers.layers.images.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.optionsPublished scene.layers.layers.options option. | CreateImageOptions | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransformPublished scene.layers.layers.options.groupTransform option. | GroupTransformOptions | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.blendModePublished scene.layers.layers.options.groupTransform.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.blurPublished scene.layers.layers.options.groupTransform.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.borderPositionPublished scene.layers.layers.options.groupTransform.borderPosition option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.borderRadiusPublished scene.layers.layers.options.groupTransform.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.boxBackgroundPublished scene.layers.layers.options.groupTransform.boxBackground option. | BoxBackground | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.boxBackground.colorPublished scene.layers.layers.options.groupTransform.boxBackground.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.boxBackground.gradientPublished scene.layers.layers.options.groupTransform.boxBackground.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.boxBackground.gradient.colorsPublished scene.layers.layers.options.groupTransform.boxBackground.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.boxBackground.gradient.colors.colorPublished scene.layers.layers.options.groupTransform.boxBackground.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.boxBackground.gradient.colors.stopPublished scene.layers.layers.options.groupTransform.boxBackground.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.boxBackground.gradient.endXPublished scene.layers.layers.options.groupTransform.boxBackground.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.boxBackground.gradient.endYPublished scene.layers.layers.options.groupTransform.boxBackground.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.boxBackground.gradient.pivotXPublished scene.layers.layers.options.groupTransform.boxBackground.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.boxBackground.gradient.pivotYPublished scene.layers.layers.options.groupTransform.boxBackground.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.boxBackground.gradient.repeatPublished scene.layers.layers.options.groupTransform.boxBackground.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.boxBackground.gradient.rotatePublished scene.layers.layers.options.groupTransform.boxBackground.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.boxBackground.gradient.startXPublished scene.layers.layers.options.groupTransform.boxBackground.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.boxBackground.gradient.startYPublished scene.layers.layers.options.groupTransform.boxBackground.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.boxBackground.gradient.typePublished scene.layers.layers.options.groupTransform.boxBackground.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.boxBackground.gradient.endRadiusPublished scene.layers.layers.options.groupTransform.boxBackground.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.boxBackground.gradient.startRadiusPublished scene.layers.layers.options.groupTransform.boxBackground.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.boxBackground.gradient.centerXPublished scene.layers.layers.options.groupTransform.boxBackground.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.boxBackground.gradient.centerYPublished scene.layers.layers.options.groupTransform.boxBackground.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.boxBackground.gradient.startAnglePublished scene.layers.layers.options.groupTransform.boxBackground.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.clipPathPublished scene.layers.layers.options.groupTransform.clipPath option. | { x: number; y: number; }[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.clipPath.xPublished scene.layers.layers.options.groupTransform.clipPath.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.clipPath.yPublished scene.layers.layers.options.groupTransform.clipPath.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.distortionPublished scene.layers.layers.options.groupTransform.distortion option. | { type: "perspective" | "warp" | "bulge" | "pinch"; points?: { x: number; y: number; }[]; intensity?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.distortion.intensityPublished scene.layers.layers.options.groupTransform.distortion.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.distortion.pointsPublished scene.layers.layers.options.groupTransform.distortion.points option. | { x: number; y: number; }[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.distortion.points.xPublished scene.layers.layers.options.groupTransform.distortion.points.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.distortion.points.yPublished scene.layers.layers.options.groupTransform.distortion.points.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.distortion.typePublished scene.layers.layers.options.groupTransform.distortion.type option. | "perspective" | "warp" | "bulge" | "pinch" | RequiredDefaultRequired | "perspective" "warp" "bulge" "pinch" | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.effectsPublished scene.layers.layers.options.groupTransform.effects option. | { vignette?: { intensity: number; size: number; }; lensFlare?: { x: number; y: number; intensity: number; }; chromaticAberration?: { intensity: number; }; filmGrain?: { intensity: number; }; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.effects.chromaticAberrationPublished scene.layers.layers.options.groupTransform.effects.chromaticAberration option. | { intensity: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.effects.chromaticAberration.intensityPublished scene.layers.layers.options.groupTransform.effects.chromaticAberration.intensity option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.effects.filmGrainPublished scene.layers.layers.options.groupTransform.effects.filmGrain option. | { intensity: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.effects.filmGrain.intensityPublished scene.layers.layers.options.groupTransform.effects.filmGrain.intensity option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.effects.lensFlarePublished scene.layers.layers.options.groupTransform.effects.lensFlare option. | { x: number; y: number; intensity: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.effects.lensFlare.intensityPublished scene.layers.layers.options.groupTransform.effects.lensFlare.intensity option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.effects.lensFlare.xPublished scene.layers.layers.options.groupTransform.effects.lensFlare.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.effects.lensFlare.yPublished scene.layers.layers.options.groupTransform.effects.lensFlare.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.effects.vignettePublished scene.layers.layers.options.groupTransform.effects.vignette option. | { intensity: number; size: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.effects.vignette.intensityPublished scene.layers.layers.options.groupTransform.effects.vignette.intensity option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.effects.vignette.sizePublished scene.layers.layers.options.groupTransform.effects.vignette.size option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.filterIntensityPublished scene.layers.layers.options.groupTransform.filterIntensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.filterOrderPublished scene.layers.layers.options.groupTransform.filterOrder option. | "pre" | "post" | OptionalDefault— | "pre" "post" | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.filtersPublished scene.layers.layers.options.groupTransform.filters option. | ImageFilter[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.filters.anglePublished scene.layers.layers.options.groupTransform.filters.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.filters.centerXPublished scene.layers.layers.options.groupTransform.filters.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.filters.centerYPublished scene.layers.layers.options.groupTransform.filters.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.filters.heightPublished scene.layers.layers.options.groupTransform.filters.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.filters.intensityPublished scene.layers.layers.options.groupTransform.filters.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.filters.levelsPublished scene.layers.layers.options.groupTransform.filters.levels option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.filters.radiusPublished scene.layers.layers.options.groupTransform.filters.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.filters.sizePublished scene.layers.layers.options.groupTransform.filters.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.filters.typePublished scene.layers.layers.options.groupTransform.filters.type option. | "saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize" | RequiredDefaultRequired | 17 values"saturation" "gaussianBlur" "motionBlur" "radialBlur" "sharpen" "noise" "grain" "edgeDetection" "emboss" "invert" "grayscale" "sepia" "pixelate" "brightness" "contrast" "hueShift" "posterize" | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.filters.valuePublished scene.layers.layers.options.groupTransform.filters.value option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.filters.widthPublished scene.layers.layers.options.groupTransform.filters.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.filters.xOptional pixelate region. Omit for the whole filtered surface. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.filters.yPublished scene.layers.layers.options.groupTransform.filters.y option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.maskPublished scene.layers.layers.options.groupTransform.mask option. | { source: string | Buffer<ArrayBufferLike>; mode?: "alpha" | "luminance" | "inverse"; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.mask.modePublished scene.layers.layers.options.groupTransform.mask.mode option. | "alpha" | "luminance" | "inverse" | OptionalDefault— | "alpha" "luminance" "inverse" | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.mask.sourcePublished scene.layers.layers.options.groupTransform.mask.source option. | string | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.meshWarpPublished scene.layers.layers.options.groupTransform.meshWarp option. | { gridX?: number; gridY?: number; controlPoints?: { x: number; y: number; }[][]; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.meshWarp.controlPointsPublished scene.layers.layers.options.groupTransform.meshWarp.controlPoints option. | { x: number; y: number; }[][] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.meshWarp.controlPoints.xPublished scene.layers.layers.options.groupTransform.meshWarp.controlPoints.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.meshWarp.controlPoints.yPublished scene.layers.layers.options.groupTransform.meshWarp.controlPoints.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.meshWarp.gridXPublished scene.layers.layers.options.groupTransform.meshWarp.gridX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.meshWarp.gridYPublished scene.layers.layers.options.groupTransform.meshWarp.gridY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.opacityPublished scene.layers.layers.options.groupTransform.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.pivotXPublished scene.layers.layers.options.groupTransform.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.pivotYPublished scene.layers.layers.options.groupTransform.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.rotationPublished scene.layers.layers.options.groupTransform.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.scaleXPublished scene.layers.layers.options.groupTransform.scaleX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.scaleYPublished scene.layers.layers.options.groupTransform.scaleY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadowPublished scene.layers.layers.options.groupTransform.shadow option. | ShadowOptions | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.blurPublished scene.layers.layers.options.groupTransform.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.borderPositionPublished scene.layers.layers.options.groupTransform.shadow.borderPosition option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.borderRadiusPublished scene.layers.layers.options.groupTransform.shadow.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.colorPublished scene.layers.layers.options.groupTransform.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.gradientPublished scene.layers.layers.options.groupTransform.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.gradient.colorsPublished scene.layers.layers.options.groupTransform.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.gradient.colors.colorPublished scene.layers.layers.options.groupTransform.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.gradient.colors.stopPublished scene.layers.layers.options.groupTransform.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.gradient.endXPublished scene.layers.layers.options.groupTransform.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.gradient.endYPublished scene.layers.layers.options.groupTransform.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.gradient.pivotXPublished scene.layers.layers.options.groupTransform.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.gradient.pivotYPublished scene.layers.layers.options.groupTransform.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.gradient.repeatPublished scene.layers.layers.options.groupTransform.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.gradient.rotatePublished scene.layers.layers.options.groupTransform.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.gradient.startXPublished scene.layers.layers.options.groupTransform.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.gradient.startYPublished scene.layers.layers.options.groupTransform.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.gradient.typePublished scene.layers.layers.options.groupTransform.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.gradient.endRadiusPublished scene.layers.layers.options.groupTransform.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.gradient.startRadiusPublished scene.layers.layers.options.groupTransform.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.gradient.centerXPublished scene.layers.layers.options.groupTransform.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.gradient.centerYPublished scene.layers.layers.options.groupTransform.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.gradient.startAnglePublished scene.layers.layers.options.groupTransform.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.offsetXPublished scene.layers.layers.options.groupTransform.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.offsetYPublished scene.layers.layers.options.groupTransform.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.opacityPublished scene.layers.layers.options.groupTransform.shadow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.shadow.roundedCornersPublished scene.layers.layers.options.groupTransform.shadow.roundedCorners option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.strokePublished scene.layers.layers.options.groupTransform.stroke option. | StrokeOptions | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.blurPublished scene.layers.layers.options.groupTransform.stroke.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.borderPositionPublished scene.layers.layers.options.groupTransform.stroke.borderPosition option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.borderRadiusPublished scene.layers.layers.options.groupTransform.stroke.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.colorPublished scene.layers.layers.options.groupTransform.stroke.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.gradientPublished scene.layers.layers.options.groupTransform.stroke.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.gradient.colorsPublished scene.layers.layers.options.groupTransform.stroke.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.gradient.colors.colorPublished scene.layers.layers.options.groupTransform.stroke.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.gradient.colors.stopPublished scene.layers.layers.options.groupTransform.stroke.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.gradient.endXPublished scene.layers.layers.options.groupTransform.stroke.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.gradient.endYPublished scene.layers.layers.options.groupTransform.stroke.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.gradient.pivotXPublished scene.layers.layers.options.groupTransform.stroke.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.gradient.pivotYPublished scene.layers.layers.options.groupTransform.stroke.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.gradient.repeatPublished scene.layers.layers.options.groupTransform.stroke.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.gradient.rotatePublished scene.layers.layers.options.groupTransform.stroke.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.gradient.startXPublished scene.layers.layers.options.groupTransform.stroke.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.gradient.startYPublished scene.layers.layers.options.groupTransform.stroke.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.gradient.typePublished scene.layers.layers.options.groupTransform.stroke.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.gradient.endRadiusPublished scene.layers.layers.options.groupTransform.stroke.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.gradient.startRadiusPublished scene.layers.layers.options.groupTransform.stroke.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.gradient.centerXPublished scene.layers.layers.options.groupTransform.stroke.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.gradient.centerYPublished scene.layers.layers.options.groupTransform.stroke.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.gradient.startAnglePublished scene.layers.layers.options.groupTransform.stroke.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.opacityPublished scene.layers.layers.options.groupTransform.stroke.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.positionPublished scene.layers.layers.options.groupTransform.stroke.position option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.roundedCornersPublished scene.layers.layers.options.groupTransform.stroke.roundedCorners option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.stylePublished scene.layers.layers.options.groupTransform.stroke.style option. | "solid" | "dashed" | "dotted" | "groove" | "ridge" | "double" | OptionalDefault— | 6 values"solid" "dashed" "dotted" "groove" "ridge" "double" | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.stroke.widthPublished scene.layers.layers.options.groupTransform.stroke.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.translateXPublished scene.layers.layers.options.groupTransform.translateX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.groupTransform.translateYPublished scene.layers.layers.options.groupTransform.translateY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.options.isGroupedPublished scene.layers.layers.options.isGrouped option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.layers.typePublished scene.layers.layers.type option. | "image" | RequiredDefaultRequired | "image" | node22 · node24 · node26 |
scene.layers.layers.textsPublished scene.layers.layers.texts option. | TextProperties | TextProperties[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.boldPublished scene.layers.layers.texts.bold option.Deprecated | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.layers.texts.colorPublished scene.layers.layers.texts.color option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorationsGrouped line decorations (`underline` / `overline` / `strikethrough`) and optional `bold` / `italic` flags for the canvas font string. Nested keys override the legacy flat fields (see {@link resolveTextDecorations}). | TextDecorations | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.boldPublished scene.layers.layers.texts.decorations.bold option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.italicPublished scene.layers.layers.texts.decorations.italic option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overlinePublished scene.layers.layers.texts.decorations.overline option. | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overline.colorPublished scene.layers.layers.texts.decorations.overline.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overline.gradientPublished scene.layers.layers.texts.decorations.overline.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overline.gradient.colorsPublished scene.layers.layers.texts.decorations.overline.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overline.gradient.colors.colorPublished scene.layers.layers.texts.decorations.overline.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overline.gradient.colors.stopPublished scene.layers.layers.texts.decorations.overline.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overline.gradient.endXPublished scene.layers.layers.texts.decorations.overline.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overline.gradient.endYPublished scene.layers.layers.texts.decorations.overline.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overline.gradient.pivotXPublished scene.layers.layers.texts.decorations.overline.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overline.gradient.pivotYPublished scene.layers.layers.texts.decorations.overline.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overline.gradient.repeatPublished scene.layers.layers.texts.decorations.overline.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overline.gradient.rotatePublished scene.layers.layers.texts.decorations.overline.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overline.gradient.startXPublished scene.layers.layers.texts.decorations.overline.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overline.gradient.startYPublished scene.layers.layers.texts.decorations.overline.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overline.gradient.typePublished scene.layers.layers.texts.decorations.overline.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overline.gradient.endRadiusPublished scene.layers.layers.texts.decorations.overline.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overline.gradient.startRadiusPublished scene.layers.layers.texts.decorations.overline.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overline.gradient.centerXPublished scene.layers.layers.texts.decorations.overline.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overline.gradient.centerYPublished scene.layers.layers.texts.decorations.overline.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overline.gradient.startAnglePublished scene.layers.layers.texts.decorations.overline.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.overline.widthPublished scene.layers.layers.texts.decorations.overline.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethroughPublished scene.layers.layers.texts.decorations.strikethrough option. | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethrough.colorPublished scene.layers.layers.texts.decorations.strikethrough.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethrough.gradientPublished scene.layers.layers.texts.decorations.strikethrough.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethrough.gradient.colorsPublished scene.layers.layers.texts.decorations.strikethrough.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethrough.gradient.colors.colorPublished scene.layers.layers.texts.decorations.strikethrough.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethrough.gradient.colors.stopPublished scene.layers.layers.texts.decorations.strikethrough.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethrough.gradient.endXPublished scene.layers.layers.texts.decorations.strikethrough.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethrough.gradient.endYPublished scene.layers.layers.texts.decorations.strikethrough.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethrough.gradient.pivotXPublished scene.layers.layers.texts.decorations.strikethrough.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethrough.gradient.pivotYPublished scene.layers.layers.texts.decorations.strikethrough.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethrough.gradient.repeatPublished scene.layers.layers.texts.decorations.strikethrough.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethrough.gradient.rotatePublished scene.layers.layers.texts.decorations.strikethrough.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethrough.gradient.startXPublished scene.layers.layers.texts.decorations.strikethrough.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethrough.gradient.startYPublished scene.layers.layers.texts.decorations.strikethrough.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethrough.gradient.typePublished scene.layers.layers.texts.decorations.strikethrough.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethrough.gradient.endRadiusPublished scene.layers.layers.texts.decorations.strikethrough.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethrough.gradient.startRadiusPublished scene.layers.layers.texts.decorations.strikethrough.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethrough.gradient.centerXPublished scene.layers.layers.texts.decorations.strikethrough.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethrough.gradient.centerYPublished scene.layers.layers.texts.decorations.strikethrough.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethrough.gradient.startAnglePublished scene.layers.layers.texts.decorations.strikethrough.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.strikethrough.widthPublished scene.layers.layers.texts.decorations.strikethrough.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underlinePublished scene.layers.layers.texts.decorations.underline option. | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underline.colorPublished scene.layers.layers.texts.decorations.underline.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underline.gradientPublished scene.layers.layers.texts.decorations.underline.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underline.gradient.colorsPublished scene.layers.layers.texts.decorations.underline.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underline.gradient.colors.colorPublished scene.layers.layers.texts.decorations.underline.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underline.gradient.colors.stopPublished scene.layers.layers.texts.decorations.underline.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underline.gradient.endXPublished scene.layers.layers.texts.decorations.underline.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underline.gradient.endYPublished scene.layers.layers.texts.decorations.underline.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underline.gradient.pivotXPublished scene.layers.layers.texts.decorations.underline.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underline.gradient.pivotYPublished scene.layers.layers.texts.decorations.underline.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underline.gradient.repeatPublished scene.layers.layers.texts.decorations.underline.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underline.gradient.rotatePublished scene.layers.layers.texts.decorations.underline.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underline.gradient.startXPublished scene.layers.layers.texts.decorations.underline.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underline.gradient.startYPublished scene.layers.layers.texts.decorations.underline.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underline.gradient.typePublished scene.layers.layers.texts.decorations.underline.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underline.gradient.endRadiusPublished scene.layers.layers.texts.decorations.underline.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underline.gradient.startRadiusPublished scene.layers.layers.texts.decorations.underline.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underline.gradient.centerXPublished scene.layers.layers.texts.decorations.underline.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underline.gradient.centerYPublished scene.layers.layers.texts.decorations.underline.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underline.gradient.startAnglePublished scene.layers.layers.texts.decorations.underline.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.decorations.underline.widthPublished scene.layers.layers.texts.decorations.underline.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effectsGrouped highlight, glow, and shadow. When set, entries override the legacy flat fields (see {@link resolveTextEffects}). | TextEffects | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glowPublished scene.layers.layers.texts.effects.glow option. | TextGlowStyle | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.colorPublished scene.layers.layers.texts.effects.glow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.gradientPublished scene.layers.layers.texts.effects.glow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.gradient.colorsPublished scene.layers.layers.texts.effects.glow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.gradient.colors.colorPublished scene.layers.layers.texts.effects.glow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.gradient.colors.stopPublished scene.layers.layers.texts.effects.glow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.gradient.endXPublished scene.layers.layers.texts.effects.glow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.gradient.endYPublished scene.layers.layers.texts.effects.glow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.gradient.pivotXPublished scene.layers.layers.texts.effects.glow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.gradient.pivotYPublished scene.layers.layers.texts.effects.glow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.gradient.repeatPublished scene.layers.layers.texts.effects.glow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.gradient.rotatePublished scene.layers.layers.texts.effects.glow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.gradient.startXPublished scene.layers.layers.texts.effects.glow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.gradient.startYPublished scene.layers.layers.texts.effects.glow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.gradient.typePublished scene.layers.layers.texts.effects.glow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.gradient.endRadiusPublished scene.layers.layers.texts.effects.glow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.gradient.startRadiusPublished scene.layers.layers.texts.effects.glow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.gradient.centerXPublished scene.layers.layers.texts.effects.glow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.gradient.centerYPublished scene.layers.layers.texts.effects.glow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.gradient.startAnglePublished scene.layers.layers.texts.effects.glow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.intensityPublished scene.layers.layers.texts.effects.glow.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.glow.opacityPublished scene.layers.layers.texts.effects.glow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlightPublished scene.layers.layers.texts.effects.highlight option. | TextHighlightStyle | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlight.colorPublished scene.layers.layers.texts.effects.highlight.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlight.gradientPublished scene.layers.layers.texts.effects.highlight.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlight.gradient.colorsPublished scene.layers.layers.texts.effects.highlight.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlight.gradient.colors.colorPublished scene.layers.layers.texts.effects.highlight.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlight.gradient.colors.stopPublished scene.layers.layers.texts.effects.highlight.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlight.gradient.endXPublished scene.layers.layers.texts.effects.highlight.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlight.gradient.endYPublished scene.layers.layers.texts.effects.highlight.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlight.gradient.pivotXPublished scene.layers.layers.texts.effects.highlight.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlight.gradient.pivotYPublished scene.layers.layers.texts.effects.highlight.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlight.gradient.repeatPublished scene.layers.layers.texts.effects.highlight.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlight.gradient.rotatePublished scene.layers.layers.texts.effects.highlight.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlight.gradient.startXPublished scene.layers.layers.texts.effects.highlight.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlight.gradient.startYPublished scene.layers.layers.texts.effects.highlight.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlight.gradient.typePublished scene.layers.layers.texts.effects.highlight.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlight.gradient.endRadiusPublished scene.layers.layers.texts.effects.highlight.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlight.gradient.startRadiusPublished scene.layers.layers.texts.effects.highlight.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlight.gradient.centerXPublished scene.layers.layers.texts.effects.highlight.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlight.gradient.centerYPublished scene.layers.layers.texts.effects.highlight.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlight.gradient.startAnglePublished scene.layers.layers.texts.effects.highlight.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.highlight.opacityPublished scene.layers.layers.texts.effects.highlight.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadowPublished scene.layers.layers.texts.effects.shadow option. | TextShadowStyle | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.blurPublished scene.layers.layers.texts.effects.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.colorPublished scene.layers.layers.texts.effects.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.gradientPublished scene.layers.layers.texts.effects.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.gradient.colorsPublished scene.layers.layers.texts.effects.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.gradient.colors.colorPublished scene.layers.layers.texts.effects.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.gradient.colors.stopPublished scene.layers.layers.texts.effects.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.gradient.endXPublished scene.layers.layers.texts.effects.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.gradient.endYPublished scene.layers.layers.texts.effects.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.gradient.pivotXPublished scene.layers.layers.texts.effects.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.gradient.pivotYPublished scene.layers.layers.texts.effects.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.gradient.repeatPublished scene.layers.layers.texts.effects.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.gradient.rotatePublished scene.layers.layers.texts.effects.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.gradient.startXPublished scene.layers.layers.texts.effects.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.gradient.startYPublished scene.layers.layers.texts.effects.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.gradient.typePublished scene.layers.layers.texts.effects.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.gradient.endRadiusPublished scene.layers.layers.texts.effects.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.gradient.startRadiusPublished scene.layers.layers.texts.effects.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.gradient.centerXPublished scene.layers.layers.texts.effects.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.gradient.centerYPublished scene.layers.layers.texts.effects.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.gradient.startAnglePublished scene.layers.layers.texts.effects.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.offsetXPublished scene.layers.layers.texts.effects.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.offsetYPublished scene.layers.layers.texts.effects.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.effects.shadow.opacityPublished scene.layers.layers.texts.effects.shadow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fillGrouped fill color / gradient and draw opacity (see {@link resolveTextFill}). | TextFill | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fill.colorPublished scene.layers.layers.texts.fill.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fill.gradientPublished scene.layers.layers.texts.fill.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fill.gradient.colorsPublished scene.layers.layers.texts.fill.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.fill.gradient.colors.colorPublished scene.layers.layers.texts.fill.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.fill.gradient.colors.stopPublished scene.layers.layers.texts.fill.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.fill.gradient.endXPublished scene.layers.layers.texts.fill.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fill.gradient.endYPublished scene.layers.layers.texts.fill.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fill.gradient.pivotXPublished scene.layers.layers.texts.fill.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fill.gradient.pivotYPublished scene.layers.layers.texts.fill.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fill.gradient.repeatPublished scene.layers.layers.texts.fill.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.texts.fill.gradient.rotatePublished scene.layers.layers.texts.fill.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fill.gradient.startXPublished scene.layers.layers.texts.fill.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fill.gradient.startYPublished scene.layers.layers.texts.fill.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fill.gradient.typePublished scene.layers.layers.texts.fill.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.texts.fill.gradient.endRadiusPublished scene.layers.layers.texts.fill.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fill.gradient.startRadiusPublished scene.layers.layers.texts.fill.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fill.gradient.centerXPublished scene.layers.layers.texts.fill.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fill.gradient.centerYPublished scene.layers.layers.texts.fill.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fill.gradient.startAnglePublished scene.layers.layers.texts.fill.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fill.opacityPublished scene.layers.layers.texts.fill.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fontPublished scene.layers.layers.texts.font option. | { size?: number; family?: string; name?: string; path?: string; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.font.familyPublished scene.layers.layers.texts.font.family option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.font.namePublished scene.layers.layers.texts.font.name option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.font.pathPublished scene.layers.layers.texts.font.path option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.font.sizePublished scene.layers.layers.texts.font.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fontFamilyPublished scene.layers.layers.texts.fontFamily option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fontNamePublished scene.layers.layers.texts.fontName option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fontPathPublished scene.layers.layers.texts.fontPath option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.fontSizePublished scene.layers.layers.texts.fontSize option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.glowPublished scene.layers.layers.texts.glow option.Deprecated | TextGlowStyle | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.glow.colorPublished scene.layers.layers.texts.glow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.glow.gradientPublished scene.layers.layers.texts.glow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.glow.gradient.colorsPublished scene.layers.layers.texts.glow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.glow.gradient.colors.colorPublished scene.layers.layers.texts.glow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.glow.gradient.colors.stopPublished scene.layers.layers.texts.glow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.glow.gradient.endXPublished scene.layers.layers.texts.glow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.glow.gradient.endYPublished scene.layers.layers.texts.glow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.glow.gradient.pivotXPublished scene.layers.layers.texts.glow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.glow.gradient.pivotYPublished scene.layers.layers.texts.glow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.glow.gradient.repeatPublished scene.layers.layers.texts.glow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.texts.glow.gradient.rotatePublished scene.layers.layers.texts.glow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.glow.gradient.startXPublished scene.layers.layers.texts.glow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.glow.gradient.startYPublished scene.layers.layers.texts.glow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.glow.gradient.typePublished scene.layers.layers.texts.glow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.texts.glow.gradient.endRadiusPublished scene.layers.layers.texts.glow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.glow.gradient.startRadiusPublished scene.layers.layers.texts.glow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.glow.gradient.centerXPublished scene.layers.layers.texts.glow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.glow.gradient.centerYPublished scene.layers.layers.texts.glow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.glow.gradient.startAnglePublished scene.layers.layers.texts.glow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.glow.intensityPublished scene.layers.layers.texts.glow.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.glow.opacityPublished scene.layers.layers.texts.glow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.gradientPublished scene.layers.layers.texts.gradient option.Deprecated | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.gradient.colorsPublished scene.layers.layers.texts.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.gradient.colors.colorPublished scene.layers.layers.texts.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.gradient.colors.stopPublished scene.layers.layers.texts.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.gradient.endXPublished scene.layers.layers.texts.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.gradient.endYPublished scene.layers.layers.texts.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.gradient.pivotXPublished scene.layers.layers.texts.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.gradient.pivotYPublished scene.layers.layers.texts.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.gradient.repeatPublished scene.layers.layers.texts.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.texts.gradient.rotatePublished scene.layers.layers.texts.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.gradient.startXPublished scene.layers.layers.texts.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.gradient.startYPublished scene.layers.layers.texts.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.gradient.typePublished scene.layers.layers.texts.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.texts.gradient.endRadiusPublished scene.layers.layers.texts.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.gradient.startRadiusPublished scene.layers.layers.texts.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.gradient.centerXPublished scene.layers.layers.texts.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.gradient.centerYPublished scene.layers.layers.texts.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.gradient.startAnglePublished scene.layers.layers.texts.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.highlightPublished scene.layers.layers.texts.highlight option.Deprecated | TextHighlightStyle | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.highlight.colorPublished scene.layers.layers.texts.highlight.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.highlight.gradientPublished scene.layers.layers.texts.highlight.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.highlight.gradient.colorsPublished scene.layers.layers.texts.highlight.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.highlight.gradient.colors.colorPublished scene.layers.layers.texts.highlight.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.highlight.gradient.colors.stopPublished scene.layers.layers.texts.highlight.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.highlight.gradient.endXPublished scene.layers.layers.texts.highlight.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.highlight.gradient.endYPublished scene.layers.layers.texts.highlight.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.highlight.gradient.pivotXPublished scene.layers.layers.texts.highlight.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.highlight.gradient.pivotYPublished scene.layers.layers.texts.highlight.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.highlight.gradient.repeatPublished scene.layers.layers.texts.highlight.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.texts.highlight.gradient.rotatePublished scene.layers.layers.texts.highlight.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.highlight.gradient.startXPublished scene.layers.layers.texts.highlight.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.highlight.gradient.startYPublished scene.layers.layers.texts.highlight.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.highlight.gradient.typePublished scene.layers.layers.texts.highlight.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.texts.highlight.gradient.endRadiusPublished scene.layers.layers.texts.highlight.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.highlight.gradient.startRadiusPublished scene.layers.layers.texts.highlight.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.highlight.gradient.centerXPublished scene.layers.layers.texts.highlight.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.highlight.gradient.centerYPublished scene.layers.layers.texts.highlight.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.highlight.gradient.startAnglePublished scene.layers.layers.texts.highlight.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.highlight.opacityPublished scene.layers.layers.texts.highlight.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.includeCharMetricsPublished scene.layers.layers.texts.includeCharMetrics option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.layers.texts.italicPublished scene.layers.layers.texts.italic option.Deprecated | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.layers.texts.layoutGrouped line height, spacing, and wrap bounds (see {@link resolveTextLayout}). | TextLayout | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.layout.letterSpacingPublished scene.layers.layers.texts.layout.letterSpacing option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.layout.lineHeightPublished scene.layers.layers.texts.layout.lineHeight option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.layout.maxHeightPublished scene.layers.layers.texts.layout.maxHeight option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.layout.maxWidthPublished scene.layers.layers.texts.layout.maxWidth option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.layout.wordSpacingPublished scene.layers.layers.texts.layout.wordSpacing option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.letterSpacingPublished scene.layers.layers.texts.letterSpacing option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.lineHeightPublished scene.layers.layers.texts.lineHeight option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.maxHeightPublished scene.layers.layers.texts.maxHeight option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.maxWidthPublished scene.layers.layers.texts.maxWidth option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.measurementCanvasPublished scene.layers.layers.texts.measurementCanvas option. | { width?: number; height?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.measurementCanvas.heightPublished scene.layers.layers.texts.measurementCanvas.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.measurementCanvas.widthPublished scene.layers.layers.texts.measurementCanvas.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.opacityPublished scene.layers.layers.texts.opacity option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.overlinePublished scene.layers.layers.texts.overline option.Deprecated | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.overline.colorPublished scene.layers.layers.texts.overline.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.overline.gradientPublished scene.layers.layers.texts.overline.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.overline.gradient.colorsPublished scene.layers.layers.texts.overline.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.overline.gradient.colors.colorPublished scene.layers.layers.texts.overline.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.overline.gradient.colors.stopPublished scene.layers.layers.texts.overline.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.overline.gradient.endXPublished scene.layers.layers.texts.overline.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.overline.gradient.endYPublished scene.layers.layers.texts.overline.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.overline.gradient.pivotXPublished scene.layers.layers.texts.overline.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.overline.gradient.pivotYPublished scene.layers.layers.texts.overline.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.overline.gradient.repeatPublished scene.layers.layers.texts.overline.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.texts.overline.gradient.rotatePublished scene.layers.layers.texts.overline.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.overline.gradient.startXPublished scene.layers.layers.texts.overline.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.overline.gradient.startYPublished scene.layers.layers.texts.overline.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.overline.gradient.typePublished scene.layers.layers.texts.overline.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.texts.overline.gradient.endRadiusPublished scene.layers.layers.texts.overline.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.overline.gradient.startRadiusPublished scene.layers.layers.texts.overline.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.overline.gradient.centerXPublished scene.layers.layers.texts.overline.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.overline.gradient.centerYPublished scene.layers.layers.texts.overline.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.overline.gradient.startAnglePublished scene.layers.layers.texts.overline.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.overline.widthPublished scene.layers.layers.texts.overline.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.placementGrouped alignment, baseline, and rotation (see {@link resolveTextPlacement}). | TextPlacement | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.placement.rotationPublished scene.layers.layers.texts.placement.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.placement.textAlignPublished scene.layers.layers.texts.placement.textAlign option. | TextAlignMode | OptionalDefault— | 5 values"center" "left" "right" "start" "end" | node22 · node24 · node26 |
scene.layers.layers.texts.placement.textBaselinePublished scene.layers.layers.texts.placement.textBaseline option. | TextBaselineMode | OptionalDefault— | 6 values"top" "bottom" "alphabetic" "hanging" "ideographic" "middle" | node22 · node24 · node26 |
scene.layers.layers.texts.rotationPublished scene.layers.layers.texts.rotation option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadowPublished scene.layers.layers.texts.shadow option.Deprecated | TextShadowStyle | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.blurPublished scene.layers.layers.texts.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.colorPublished scene.layers.layers.texts.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.gradientPublished scene.layers.layers.texts.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.gradient.colorsPublished scene.layers.layers.texts.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.gradient.colors.colorPublished scene.layers.layers.texts.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.gradient.colors.stopPublished scene.layers.layers.texts.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.gradient.endXPublished scene.layers.layers.texts.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.gradient.endYPublished scene.layers.layers.texts.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.gradient.pivotXPublished scene.layers.layers.texts.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.gradient.pivotYPublished scene.layers.layers.texts.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.gradient.repeatPublished scene.layers.layers.texts.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.gradient.rotatePublished scene.layers.layers.texts.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.gradient.startXPublished scene.layers.layers.texts.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.gradient.startYPublished scene.layers.layers.texts.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.gradient.typePublished scene.layers.layers.texts.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.gradient.endRadiusPublished scene.layers.layers.texts.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.gradient.startRadiusPublished scene.layers.layers.texts.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.gradient.centerXPublished scene.layers.layers.texts.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.gradient.centerYPublished scene.layers.layers.texts.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.gradient.startAnglePublished scene.layers.layers.texts.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.offsetXPublished scene.layers.layers.texts.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.offsetYPublished scene.layers.layers.texts.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.shadow.opacityPublished scene.layers.layers.texts.shadow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.strikethroughPublished scene.layers.layers.texts.strikethrough option.Deprecated | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.strikethrough.colorPublished scene.layers.layers.texts.strikethrough.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.strikethrough.gradientPublished scene.layers.layers.texts.strikethrough.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.strikethrough.gradient.colorsPublished scene.layers.layers.texts.strikethrough.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.strikethrough.gradient.colors.colorPublished scene.layers.layers.texts.strikethrough.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.strikethrough.gradient.colors.stopPublished scene.layers.layers.texts.strikethrough.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.strikethrough.gradient.endXPublished scene.layers.layers.texts.strikethrough.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.strikethrough.gradient.endYPublished scene.layers.layers.texts.strikethrough.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.strikethrough.gradient.pivotXPublished scene.layers.layers.texts.strikethrough.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.strikethrough.gradient.pivotYPublished scene.layers.layers.texts.strikethrough.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.strikethrough.gradient.repeatPublished scene.layers.layers.texts.strikethrough.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.texts.strikethrough.gradient.rotatePublished scene.layers.layers.texts.strikethrough.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.strikethrough.gradient.startXPublished scene.layers.layers.texts.strikethrough.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.strikethrough.gradient.startYPublished scene.layers.layers.texts.strikethrough.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.strikethrough.gradient.typePublished scene.layers.layers.texts.strikethrough.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.texts.strikethrough.gradient.endRadiusPublished scene.layers.layers.texts.strikethrough.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.strikethrough.gradient.startRadiusPublished scene.layers.layers.texts.strikethrough.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.strikethrough.gradient.centerXPublished scene.layers.layers.texts.strikethrough.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.strikethrough.gradient.centerYPublished scene.layers.layers.texts.strikethrough.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.strikethrough.gradient.startAnglePublished scene.layers.layers.texts.strikethrough.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.strikethrough.widthPublished scene.layers.layers.texts.strikethrough.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.strokePublished scene.layers.layers.texts.stroke option. | TextStrokeStyle | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.colorPublished scene.layers.layers.texts.stroke.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.gradientPublished scene.layers.layers.texts.stroke.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.gradient.colorsPublished scene.layers.layers.texts.stroke.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.gradient.colors.colorPublished scene.layers.layers.texts.stroke.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.gradient.colors.stopPublished scene.layers.layers.texts.stroke.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.gradient.endXPublished scene.layers.layers.texts.stroke.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.gradient.endYPublished scene.layers.layers.texts.stroke.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.gradient.pivotXPublished scene.layers.layers.texts.stroke.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.gradient.pivotYPublished scene.layers.layers.texts.stroke.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.gradient.repeatPublished scene.layers.layers.texts.stroke.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.gradient.rotatePublished scene.layers.layers.texts.stroke.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.gradient.startXPublished scene.layers.layers.texts.stroke.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.gradient.startYPublished scene.layers.layers.texts.stroke.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.gradient.typePublished scene.layers.layers.texts.stroke.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.gradient.endRadiusPublished scene.layers.layers.texts.stroke.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.gradient.startRadiusPublished scene.layers.layers.texts.stroke.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.gradient.centerXPublished scene.layers.layers.texts.stroke.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.gradient.centerYPublished scene.layers.layers.texts.stroke.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.gradient.startAnglePublished scene.layers.layers.texts.stroke.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.opacityPublished scene.layers.layers.texts.stroke.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.stylePublished scene.layers.layers.texts.stroke.style option. | "solid" | "dashed" | "dotted" | "groove" | "ridge" | "double" | OptionalDefault— | 6 values"solid" "dashed" "dotted" "groove" "ridge" "double" | node22 · node24 · node26 |
scene.layers.layers.texts.stroke.widthPublished scene.layers.layers.texts.stroke.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.textPublished scene.layers.layers.texts.text option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.textAlignPublished scene.layers.layers.texts.textAlign option.Deprecated | TextAlignMode | OptionalDefault— | 5 values"center" "left" "right" "start" "end" | node22 · node24 · node26 |
scene.layers.layers.texts.textBaselinePublished scene.layers.layers.texts.textBaseline option.Deprecated | TextBaselineMode | OptionalDefault— | 6 values"top" "bottom" "alphabetic" "hanging" "ideographic" "middle" | node22 · node24 · node26 |
scene.layers.layers.texts.textOnCurvePublished scene.layers.layers.texts.textOnCurve option.Deprecated | TextCurveConfig | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.textOnCurve.baselineOffsetPublished scene.layers.layers.texts.textOnCurve.baselineOffset option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.textOnCurve.layoutModePublished scene.layers.layers.texts.textOnCurve.layoutMode option. | CurvedTextLayoutMode | OptionalDefault— | "fit" "clamp" "override" | node22 · node24 · node26 |
scene.layers.layers.texts.textOnCurve.radiusPublished scene.layers.layers.texts.textOnCurve.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.textOnCurve.startAngleDegPublished scene.layers.layers.texts.textOnCurve.startAngleDeg option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.textOnCurve.sweepAnglePublished scene.layers.layers.texts.textOnCurve.sweepAngle option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.textOnCurve.upPublished scene.layers.layers.texts.textOnCurve.up option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.layers.texts.underlinePublished scene.layers.layers.texts.underline option.Deprecated | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.underline.colorPublished scene.layers.layers.texts.underline.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.underline.gradientPublished scene.layers.layers.texts.underline.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.underline.gradient.colorsPublished scene.layers.layers.texts.underline.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.underline.gradient.colors.colorPublished scene.layers.layers.texts.underline.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.underline.gradient.colors.stopPublished scene.layers.layers.texts.underline.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.underline.gradient.endXPublished scene.layers.layers.texts.underline.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.underline.gradient.endYPublished scene.layers.layers.texts.underline.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.underline.gradient.pivotXPublished scene.layers.layers.texts.underline.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.underline.gradient.pivotYPublished scene.layers.layers.texts.underline.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.underline.gradient.repeatPublished scene.layers.layers.texts.underline.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.texts.underline.gradient.rotatePublished scene.layers.layers.texts.underline.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.underline.gradient.startXPublished scene.layers.layers.texts.underline.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.underline.gradient.startYPublished scene.layers.layers.texts.underline.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.underline.gradient.typePublished scene.layers.layers.texts.underline.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.texts.underline.gradient.endRadiusPublished scene.layers.layers.texts.underline.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.underline.gradient.startRadiusPublished scene.layers.layers.texts.underline.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.underline.gradient.centerXPublished scene.layers.layers.texts.underline.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.underline.gradient.centerYPublished scene.layers.layers.texts.underline.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.underline.gradient.startAnglePublished scene.layers.layers.texts.underline.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.underline.widthPublished scene.layers.layers.texts.underline.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.wordSpacingPublished scene.layers.layers.texts.wordSpacing option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.texts.xPublished scene.layers.layers.texts.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.texts.yPublished scene.layers.layers.texts.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.pathPublished scene.layers.layers.path option. | unknown | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.bufferPublished scene.layers.layers.buffer option. | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.globalAlphaPublished scene.layers.layers.globalAlpha option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.globalCompositeOperationPublished scene.layers.layers.globalCompositeOperation option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
scene.layers.layers.heightPublished scene.layers.layers.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.widthPublished scene.layers.layers.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.xPublished scene.layers.layers.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.yPublished scene.layers.layers.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.chartTypePublished scene.layers.layers.chartType option. | SceneChartType | RequiredDefaultRequired | 7 values"pie" "bar" "horizontalBar" "line" "scatter" "radar" "polarArea" | node22 · node24 · node26 |
scene.layers.layers.dataPublished scene.layers.layers.data option. | unknown | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.opacityPublished scene.layers.layers.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.linesPublished scene.layers.layers.lines option. | CustomOptions | CustomOptions[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.lines.arrowPublished scene.layers.layers.lines.arrow option. | { start?: boolean; end?: boolean; size?: number; style?: "filled" | "outline"; color?: string; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.arrow.colorPublished scene.layers.layers.lines.arrow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.arrow.endPublished scene.layers.layers.lines.arrow.end option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.layers.lines.arrow.sizePublished scene.layers.layers.lines.arrow.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.arrow.startPublished scene.layers.layers.lines.arrow.start option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.layers.lines.arrow.stylePublished scene.layers.layers.lines.arrow.style option. | "filled" | "outline" | OptionalDefault— | "filled" "outline" | node22 · node24 · node26 |
scene.layers.layers.lines.endCoordinatesPublished scene.layers.layers.lines.endCoordinates option. | { x: number; y: number; } | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.lines.endCoordinates.xPublished scene.layers.layers.lines.endCoordinates.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.lines.endCoordinates.yPublished scene.layers.layers.lines.endCoordinates.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStylePublished scene.layers.layers.lines.lineStyle option. | { width?: number; color?: string; gradient?: gradient; lineRadius?: string | number; lineJoin?: "round" | "bevel" | "miter"; lineCap?: "square" | "butt" | "round"; singleLine?: boolean; lineDash?: { dashArray?: number[]; offset?: number; }; pattern?: { type: "dots" | "custom" | "dashes"; segments?: number[]; offset?: number; }; texture?: string | Buffer<ArrayBufferLike>; stroke?: { color?: string; gradient?: gradient; width?: number; lineRadius?: string | number; lineCap?: "square" | "butt" | "round"; }; shadow?: { offsetX?: number; offsetY?: number; blur?: number; color?: string; gradient?: gradient; lineRadius?: string | number; }; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.colorPublished scene.layers.layers.lines.lineStyle.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.gradientPublished scene.layers.layers.lines.lineStyle.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.gradient.colorsPublished scene.layers.layers.lines.lineStyle.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.gradient.colors.colorPublished scene.layers.layers.lines.lineStyle.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.gradient.colors.stopPublished scene.layers.layers.lines.lineStyle.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.gradient.endXPublished scene.layers.layers.lines.lineStyle.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.gradient.endYPublished scene.layers.layers.lines.lineStyle.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.gradient.pivotXPublished scene.layers.layers.lines.lineStyle.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.gradient.pivotYPublished scene.layers.layers.lines.lineStyle.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.gradient.repeatPublished scene.layers.layers.lines.lineStyle.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.gradient.rotatePublished scene.layers.layers.lines.lineStyle.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.gradient.startXPublished scene.layers.layers.lines.lineStyle.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.gradient.startYPublished scene.layers.layers.lines.lineStyle.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.gradient.typePublished scene.layers.layers.lines.lineStyle.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.gradient.endRadiusPublished scene.layers.layers.lines.lineStyle.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.gradient.startRadiusPublished scene.layers.layers.lines.lineStyle.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.gradient.centerXPublished scene.layers.layers.lines.lineStyle.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.gradient.centerYPublished scene.layers.layers.lines.lineStyle.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.gradient.startAnglePublished scene.layers.layers.lines.lineStyle.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.lineCapPublished scene.layers.layers.lines.lineStyle.lineCap option. | "square" | "butt" | "round" | OptionalDefault— | "square" "butt" "round" | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.lineDashPublished scene.layers.layers.lines.lineStyle.lineDash option. | { dashArray?: number[]; offset?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.lineDash.dashArrayPublished scene.layers.layers.lines.lineStyle.lineDash.dashArray option. | number[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.lineDash.offsetPublished scene.layers.layers.lines.lineStyle.lineDash.offset option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.lineJoinPublished scene.layers.layers.lines.lineStyle.lineJoin option. | "round" | "bevel" | "miter" | OptionalDefault— | "round" "bevel" "miter" | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.lineRadiusPublished scene.layers.layers.lines.lineStyle.lineRadius option. | string | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.patternPublished scene.layers.layers.lines.lineStyle.pattern option. | { type: "dots" | "custom" | "dashes"; segments?: number[]; offset?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.pattern.offsetPublished scene.layers.layers.lines.lineStyle.pattern.offset option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.pattern.segmentsPublished scene.layers.layers.lines.lineStyle.pattern.segments option. | number[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.pattern.typePublished scene.layers.layers.lines.lineStyle.pattern.type option. | "dots" | "custom" | "dashes" | RequiredDefaultRequired | "dots" "custom" "dashes" | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadowPublished scene.layers.layers.lines.lineStyle.shadow option. | { offsetX?: number; offsetY?: number; blur?: number; color?: string; gradient?: gradient; lineRadius?: string | number; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.blurPublished scene.layers.layers.lines.lineStyle.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.colorPublished scene.layers.layers.lines.lineStyle.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.gradientPublished scene.layers.layers.lines.lineStyle.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.gradient.colorsPublished scene.layers.layers.lines.lineStyle.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.gradient.colors.colorPublished scene.layers.layers.lines.lineStyle.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.gradient.colors.stopPublished scene.layers.layers.lines.lineStyle.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.gradient.endXPublished scene.layers.layers.lines.lineStyle.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.gradient.endYPublished scene.layers.layers.lines.lineStyle.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.gradient.pivotXPublished scene.layers.layers.lines.lineStyle.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.gradient.pivotYPublished scene.layers.layers.lines.lineStyle.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.gradient.repeatPublished scene.layers.layers.lines.lineStyle.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.gradient.rotatePublished scene.layers.layers.lines.lineStyle.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.gradient.startXPublished scene.layers.layers.lines.lineStyle.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.gradient.startYPublished scene.layers.layers.lines.lineStyle.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.gradient.typePublished scene.layers.layers.lines.lineStyle.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.gradient.endRadiusPublished scene.layers.layers.lines.lineStyle.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.gradient.startRadiusPublished scene.layers.layers.lines.lineStyle.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.gradient.centerXPublished scene.layers.layers.lines.lineStyle.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.gradient.centerYPublished scene.layers.layers.lines.lineStyle.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.gradient.startAnglePublished scene.layers.layers.lines.lineStyle.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.lineRadiusPublished scene.layers.layers.lines.lineStyle.shadow.lineRadius option. | string | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.offsetXPublished scene.layers.layers.lines.lineStyle.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.shadow.offsetYPublished scene.layers.layers.lines.lineStyle.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.singleLinePublished scene.layers.layers.lines.lineStyle.singleLine option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.strokePublished scene.layers.layers.lines.lineStyle.stroke option. | { color?: string; gradient?: gradient; width?: number; lineRadius?: string | number; lineCap?: "square" | "butt" | "round"; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.colorPublished scene.layers.layers.lines.lineStyle.stroke.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.gradientPublished scene.layers.layers.lines.lineStyle.stroke.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.gradient.colorsPublished scene.layers.layers.lines.lineStyle.stroke.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.gradient.colors.colorPublished scene.layers.layers.lines.lineStyle.stroke.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.gradient.colors.stopPublished scene.layers.layers.lines.lineStyle.stroke.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.gradient.endXPublished scene.layers.layers.lines.lineStyle.stroke.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.gradient.endYPublished scene.layers.layers.lines.lineStyle.stroke.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.gradient.pivotXPublished scene.layers.layers.lines.lineStyle.stroke.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.gradient.pivotYPublished scene.layers.layers.lines.lineStyle.stroke.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.gradient.repeatPublished scene.layers.layers.lines.lineStyle.stroke.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.gradient.rotatePublished scene.layers.layers.lines.lineStyle.stroke.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.gradient.startXPublished scene.layers.layers.lines.lineStyle.stroke.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.gradient.startYPublished scene.layers.layers.lines.lineStyle.stroke.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.gradient.typePublished scene.layers.layers.lines.lineStyle.stroke.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.gradient.endRadiusPublished scene.layers.layers.lines.lineStyle.stroke.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.gradient.startRadiusPublished scene.layers.layers.lines.lineStyle.stroke.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.gradient.centerXPublished scene.layers.layers.lines.lineStyle.stroke.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.gradient.centerYPublished scene.layers.layers.lines.lineStyle.stroke.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.gradient.startAnglePublished scene.layers.layers.lines.lineStyle.stroke.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.lineCapPublished scene.layers.layers.lines.lineStyle.stroke.lineCap option. | "square" | "butt" | "round" | OptionalDefault— | "square" "butt" "round" | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.lineRadiusPublished scene.layers.layers.lines.lineStyle.stroke.lineRadius option. | string | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.stroke.widthPublished scene.layers.layers.lines.lineStyle.stroke.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.texturePublished scene.layers.layers.lines.lineStyle.texture option. | string | Buffer<ArrayBufferLike> | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.lineStyle.widthPublished scene.layers.layers.lines.lineStyle.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.markersPublished scene.layers.layers.lines.markers option. | { position: number; shape: "square" | "circle" | "diamond" | "arrow"; size: number; color: string; }[] | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.markers.colorPublished scene.layers.layers.lines.markers.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.lines.markers.positionPublished scene.layers.layers.lines.markers.position option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.lines.markers.shapePublished scene.layers.layers.lines.markers.shape option. | "square" | "circle" | "diamond" | "arrow" | RequiredDefaultRequired | "square" "circle" "diamond" "arrow" | node22 · node24 · node26 |
scene.layers.layers.lines.markers.sizePublished scene.layers.layers.lines.markers.size option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.lines.pathPublished scene.layers.layers.lines.path option. | { type: "bezier" | "smooth" | "catmull-rom"; tension?: number; closed?: boolean; } | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.path.closedPublished scene.layers.layers.lines.path.closed option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.layers.layers.lines.path.tensionPublished scene.layers.layers.lines.path.tension option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.layers.lines.path.typePublished scene.layers.layers.lines.path.type option. | "bezier" | "smooth" | "catmull-rom" | RequiredDefaultRequired | "bezier" "smooth" "catmull-rom" | node22 · node24 · node26 |
scene.layers.layers.lines.startCoordinatesPublished scene.layers.layers.lines.startCoordinates option. | { x: number; y: number; } | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.lines.startCoordinates.xPublished scene.layers.layers.lines.startCoordinates.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.layers.lines.startCoordinates.yPublished scene.layers.layers.lines.startCoordinates.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.placementPublished scene.layers.placement option. | SceneSurfacePlacement | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.placement.globalCompositeOperationPublished scene.layers.placement.globalCompositeOperation option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
scene.layers.placement.heightPublished scene.layers.placement.height option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.placement.opacityPublished scene.layers.placement.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.placement.rotationPublished scene.layers.placement.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.placement.scaleXPublished scene.layers.placement.scaleX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.placement.scaleYPublished scene.layers.placement.scaleY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
scene.layers.placement.widthPublished scene.layers.placement.width option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.placement.xPublished scene.layers.placement.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.layers.placement.yPublished scene.layers.placement.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
scene.widthPublished scene.width option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
| video | ||||
video.framesWithRepeatsPublished video.framesWithRepeats option. | SceneVideoFrameSlot[] | OptionalDefault— | — | node22 · node24 · node26 |
video.framesWithRepeats.repeatPublished video.framesWithRepeats.repeat option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.framesWithRepeats.sourcePublished video.framesWithRepeats.source option. | string | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.optionsPublished video.options option. | VideoCreationOptions | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addAnimatedTextPublished video.options.addAnimatedText option.Deprecated | { text: string; animation?: "zoom" | "rotate" | "fadeIn" | "fadeOut" | "slideIn" | "slideOut" | "bounce" | "typewriter"; startTime: number; endTime: number; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center" | { x: number; y: number; }; fontSize?: number; fontColor?: string; fontPath?: string; fontName?: string; fontFamily?: string; backgroundColor?: string; outputPath: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addAnimatedText.animationPublished video.options.addAnimatedText.animation option. | "zoom" | "rotate" | "fadeIn" | "fadeOut" | "slideIn" | "slideOut" | "bounce" | "typewriter" | OptionalDefault— | 8 values"zoom" "rotate" "fadeIn" "fadeOut" "slideIn" "slideOut" "bounce" "typewriter" | node22 · node24 · node26 |
video.options.addAnimatedText.backgroundColorPublished video.options.addAnimatedText.backgroundColor option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addAnimatedText.endTimePublished video.options.addAnimatedText.endTime option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addAnimatedText.fontColorPublished video.options.addAnimatedText.fontColor option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addAnimatedText.fontFamilyPublished video.options.addAnimatedText.fontFamily option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addAnimatedText.fontNamePublished video.options.addAnimatedText.fontName option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addAnimatedText.fontPathPublished video.options.addAnimatedText.fontPath option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addAnimatedText.fontSizePublished video.options.addAnimatedText.fontSize option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addAnimatedText.outputPathPublished video.options.addAnimatedText.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addAnimatedText.positionPublished video.options.addAnimatedText.position option. | "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center" | { x: number; y: number; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addAnimatedText.position.xPublished video.options.addAnimatedText.position.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addAnimatedText.position.yPublished video.options.addAnimatedText.position.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addAnimatedText.startTimePublished video.options.addAnimatedText.startTime option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addAnimatedText.textPublished video.options.addAnimatedText.text option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addFadePublished video.options.addFade option. | { fadeIn?: number; fadeOut?: number; outputPath: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addFade.fadeInPublished video.options.addFade.fadeIn option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addFade.fadeOutPublished video.options.addFade.fadeOut option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addFade.outputPathPublished video.options.addFade.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextPublished video.options.addText option.Deprecated | { text: string; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center"; fontSize?: number; fontColor?: string; backgroundColor?: string; startTime?: number; endTime?: number; outputPath: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addText.backgroundColorPublished video.options.addText.backgroundColor option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addText.endTimePublished video.options.addText.endTime option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addText.fontColorPublished video.options.addText.fontColor option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addText.fontSizePublished video.options.addText.fontSize option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addText.outputPathPublished video.options.addText.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addText.positionPublished video.options.addText.position option. | "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center" | OptionalDefault— | 7 values"center" "top-left" "top-right" "bottom-left" "bottom-right" "top-center" "bottom-center" | node22 · node24 · node26 |
video.options.addText.startTimePublished video.options.addText.startTime option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addText.textPublished video.options.addText.text option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlayPublished video.options.addTextOverlay option. | VideoTextOverlayOperation | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.outputPathPublished video.options.addTextOverlay.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlaysPublished video.options.addTextOverlay.overlays option. | VideoTextOverlayClip[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.boldPublished video.options.addTextOverlay.overlays.bold option.Deprecated | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.colorPublished video.options.addTextOverlay.overlays.color option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorationsGrouped line decorations (`underline` / `overline` / `strikethrough`) and optional `bold` / `italic` flags for the canvas font string. Nested keys override the legacy flat fields (see {@link resolveTextDecorations}). | TextDecorations | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.boldPublished video.options.addTextOverlay.overlays.decorations.bold option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.italicPublished video.options.addTextOverlay.overlays.decorations.italic option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overlinePublished video.options.addTextOverlay.overlays.decorations.overline option. | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overline.colorPublished video.options.addTextOverlay.overlays.decorations.overline.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overline.gradientPublished video.options.addTextOverlay.overlays.decorations.overline.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overline.gradient.colorsPublished video.options.addTextOverlay.overlays.decorations.overline.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overline.gradient.colors.colorPublished video.options.addTextOverlay.overlays.decorations.overline.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overline.gradient.colors.stopPublished video.options.addTextOverlay.overlays.decorations.overline.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overline.gradient.endXPublished video.options.addTextOverlay.overlays.decorations.overline.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overline.gradient.endYPublished video.options.addTextOverlay.overlays.decorations.overline.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overline.gradient.pivotXPublished video.options.addTextOverlay.overlays.decorations.overline.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overline.gradient.pivotYPublished video.options.addTextOverlay.overlays.decorations.overline.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overline.gradient.repeatPublished video.options.addTextOverlay.overlays.decorations.overline.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overline.gradient.rotatePublished video.options.addTextOverlay.overlays.decorations.overline.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overline.gradient.startXPublished video.options.addTextOverlay.overlays.decorations.overline.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overline.gradient.startYPublished video.options.addTextOverlay.overlays.decorations.overline.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overline.gradient.typePublished video.options.addTextOverlay.overlays.decorations.overline.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overline.gradient.endRadiusPublished video.options.addTextOverlay.overlays.decorations.overline.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overline.gradient.startRadiusPublished video.options.addTextOverlay.overlays.decorations.overline.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overline.gradient.centerXPublished video.options.addTextOverlay.overlays.decorations.overline.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overline.gradient.centerYPublished video.options.addTextOverlay.overlays.decorations.overline.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overline.gradient.startAnglePublished video.options.addTextOverlay.overlays.decorations.overline.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.overline.widthPublished video.options.addTextOverlay.overlays.decorations.overline.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethroughPublished video.options.addTextOverlay.overlays.decorations.strikethrough option. | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethrough.colorPublished video.options.addTextOverlay.overlays.decorations.strikethrough.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethrough.gradientPublished video.options.addTextOverlay.overlays.decorations.strikethrough.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.colorsPublished video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.colors.colorPublished video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.colors.stopPublished video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.endXPublished video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.endYPublished video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.pivotXPublished video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.pivotYPublished video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.repeatPublished video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.rotatePublished video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.startXPublished video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.startYPublished video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.typePublished video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.endRadiusPublished video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.startRadiusPublished video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.centerXPublished video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.centerYPublished video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.startAnglePublished video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.strikethrough.widthPublished video.options.addTextOverlay.overlays.decorations.strikethrough.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underlinePublished video.options.addTextOverlay.overlays.decorations.underline option. | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underline.colorPublished video.options.addTextOverlay.overlays.decorations.underline.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underline.gradientPublished video.options.addTextOverlay.overlays.decorations.underline.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underline.gradient.colorsPublished video.options.addTextOverlay.overlays.decorations.underline.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underline.gradient.colors.colorPublished video.options.addTextOverlay.overlays.decorations.underline.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underline.gradient.colors.stopPublished video.options.addTextOverlay.overlays.decorations.underline.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underline.gradient.endXPublished video.options.addTextOverlay.overlays.decorations.underline.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underline.gradient.endYPublished video.options.addTextOverlay.overlays.decorations.underline.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underline.gradient.pivotXPublished video.options.addTextOverlay.overlays.decorations.underline.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underline.gradient.pivotYPublished video.options.addTextOverlay.overlays.decorations.underline.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underline.gradient.repeatPublished video.options.addTextOverlay.overlays.decorations.underline.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underline.gradient.rotatePublished video.options.addTextOverlay.overlays.decorations.underline.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underline.gradient.startXPublished video.options.addTextOverlay.overlays.decorations.underline.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underline.gradient.startYPublished video.options.addTextOverlay.overlays.decorations.underline.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underline.gradient.typePublished video.options.addTextOverlay.overlays.decorations.underline.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underline.gradient.endRadiusPublished video.options.addTextOverlay.overlays.decorations.underline.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underline.gradient.startRadiusPublished video.options.addTextOverlay.overlays.decorations.underline.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underline.gradient.centerXPublished video.options.addTextOverlay.overlays.decorations.underline.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underline.gradient.centerYPublished video.options.addTextOverlay.overlays.decorations.underline.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underline.gradient.startAnglePublished video.options.addTextOverlay.overlays.decorations.underline.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.decorations.underline.widthPublished video.options.addTextOverlay.overlays.decorations.underline.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effectsGrouped highlight, glow, and shadow. When set, entries override the legacy flat fields (see {@link resolveTextEffects}). | TextEffects | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glowPublished video.options.addTextOverlay.overlays.effects.glow option. | TextGlowStyle | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.colorPublished video.options.addTextOverlay.overlays.effects.glow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.gradientPublished video.options.addTextOverlay.overlays.effects.glow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.gradient.colorsPublished video.options.addTextOverlay.overlays.effects.glow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.gradient.colors.colorPublished video.options.addTextOverlay.overlays.effects.glow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.gradient.colors.stopPublished video.options.addTextOverlay.overlays.effects.glow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.gradient.endXPublished video.options.addTextOverlay.overlays.effects.glow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.gradient.endYPublished video.options.addTextOverlay.overlays.effects.glow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.gradient.pivotXPublished video.options.addTextOverlay.overlays.effects.glow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.gradient.pivotYPublished video.options.addTextOverlay.overlays.effects.glow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.gradient.repeatPublished video.options.addTextOverlay.overlays.effects.glow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.gradient.rotatePublished video.options.addTextOverlay.overlays.effects.glow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.gradient.startXPublished video.options.addTextOverlay.overlays.effects.glow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.gradient.startYPublished video.options.addTextOverlay.overlays.effects.glow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.gradient.typePublished video.options.addTextOverlay.overlays.effects.glow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.gradient.endRadiusPublished video.options.addTextOverlay.overlays.effects.glow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.gradient.startRadiusPublished video.options.addTextOverlay.overlays.effects.glow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.gradient.centerXPublished video.options.addTextOverlay.overlays.effects.glow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.gradient.centerYPublished video.options.addTextOverlay.overlays.effects.glow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.gradient.startAnglePublished video.options.addTextOverlay.overlays.effects.glow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.intensityPublished video.options.addTextOverlay.overlays.effects.glow.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.glow.opacityPublished video.options.addTextOverlay.overlays.effects.glow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlightPublished video.options.addTextOverlay.overlays.effects.highlight option. | TextHighlightStyle | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlight.colorPublished video.options.addTextOverlay.overlays.effects.highlight.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlight.gradientPublished video.options.addTextOverlay.overlays.effects.highlight.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlight.gradient.colorsPublished video.options.addTextOverlay.overlays.effects.highlight.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlight.gradient.colors.colorPublished video.options.addTextOverlay.overlays.effects.highlight.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlight.gradient.colors.stopPublished video.options.addTextOverlay.overlays.effects.highlight.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlight.gradient.endXPublished video.options.addTextOverlay.overlays.effects.highlight.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlight.gradient.endYPublished video.options.addTextOverlay.overlays.effects.highlight.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlight.gradient.pivotXPublished video.options.addTextOverlay.overlays.effects.highlight.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlight.gradient.pivotYPublished video.options.addTextOverlay.overlays.effects.highlight.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlight.gradient.repeatPublished video.options.addTextOverlay.overlays.effects.highlight.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlight.gradient.rotatePublished video.options.addTextOverlay.overlays.effects.highlight.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlight.gradient.startXPublished video.options.addTextOverlay.overlays.effects.highlight.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlight.gradient.startYPublished video.options.addTextOverlay.overlays.effects.highlight.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlight.gradient.typePublished video.options.addTextOverlay.overlays.effects.highlight.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlight.gradient.endRadiusPublished video.options.addTextOverlay.overlays.effects.highlight.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlight.gradient.startRadiusPublished video.options.addTextOverlay.overlays.effects.highlight.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlight.gradient.centerXPublished video.options.addTextOverlay.overlays.effects.highlight.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlight.gradient.centerYPublished video.options.addTextOverlay.overlays.effects.highlight.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlight.gradient.startAnglePublished video.options.addTextOverlay.overlays.effects.highlight.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.highlight.opacityPublished video.options.addTextOverlay.overlays.effects.highlight.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadowPublished video.options.addTextOverlay.overlays.effects.shadow option. | TextShadowStyle | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.blurPublished video.options.addTextOverlay.overlays.effects.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.colorPublished video.options.addTextOverlay.overlays.effects.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.gradientPublished video.options.addTextOverlay.overlays.effects.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.gradient.colorsPublished video.options.addTextOverlay.overlays.effects.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.gradient.colors.colorPublished video.options.addTextOverlay.overlays.effects.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.gradient.colors.stopPublished video.options.addTextOverlay.overlays.effects.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.gradient.endXPublished video.options.addTextOverlay.overlays.effects.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.gradient.endYPublished video.options.addTextOverlay.overlays.effects.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.gradient.pivotXPublished video.options.addTextOverlay.overlays.effects.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.gradient.pivotYPublished video.options.addTextOverlay.overlays.effects.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.gradient.repeatPublished video.options.addTextOverlay.overlays.effects.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.gradient.rotatePublished video.options.addTextOverlay.overlays.effects.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.gradient.startXPublished video.options.addTextOverlay.overlays.effects.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.gradient.startYPublished video.options.addTextOverlay.overlays.effects.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.gradient.typePublished video.options.addTextOverlay.overlays.effects.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.gradient.endRadiusPublished video.options.addTextOverlay.overlays.effects.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.gradient.startRadiusPublished video.options.addTextOverlay.overlays.effects.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.gradient.centerXPublished video.options.addTextOverlay.overlays.effects.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.gradient.centerYPublished video.options.addTextOverlay.overlays.effects.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.gradient.startAnglePublished video.options.addTextOverlay.overlays.effects.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.offsetXPublished video.options.addTextOverlay.overlays.effects.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.offsetYPublished video.options.addTextOverlay.overlays.effects.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.effects.shadow.opacityPublished video.options.addTextOverlay.overlays.effects.shadow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.endTimeSeconds when this overlay is hidden. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fillGrouped fill color / gradient and draw opacity (see {@link resolveTextFill}). | TextFill | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fill.colorPublished video.options.addTextOverlay.overlays.fill.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fill.gradientPublished video.options.addTextOverlay.overlays.fill.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fill.gradient.colorsPublished video.options.addTextOverlay.overlays.fill.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fill.gradient.colors.colorPublished video.options.addTextOverlay.overlays.fill.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fill.gradient.colors.stopPublished video.options.addTextOverlay.overlays.fill.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fill.gradient.endXPublished video.options.addTextOverlay.overlays.fill.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fill.gradient.endYPublished video.options.addTextOverlay.overlays.fill.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fill.gradient.pivotXPublished video.options.addTextOverlay.overlays.fill.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fill.gradient.pivotYPublished video.options.addTextOverlay.overlays.fill.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fill.gradient.repeatPublished video.options.addTextOverlay.overlays.fill.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fill.gradient.rotatePublished video.options.addTextOverlay.overlays.fill.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fill.gradient.startXPublished video.options.addTextOverlay.overlays.fill.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fill.gradient.startYPublished video.options.addTextOverlay.overlays.fill.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fill.gradient.typePublished video.options.addTextOverlay.overlays.fill.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fill.gradient.endRadiusPublished video.options.addTextOverlay.overlays.fill.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fill.gradient.startRadiusPublished video.options.addTextOverlay.overlays.fill.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fill.gradient.centerXPublished video.options.addTextOverlay.overlays.fill.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fill.gradient.centerYPublished video.options.addTextOverlay.overlays.fill.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fill.gradient.startAnglePublished video.options.addTextOverlay.overlays.fill.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fill.opacityPublished video.options.addTextOverlay.overlays.fill.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fontPublished video.options.addTextOverlay.overlays.font option. | { size?: number; family?: string; name?: string; path?: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.font.familyPublished video.options.addTextOverlay.overlays.font.family option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.font.namePublished video.options.addTextOverlay.overlays.font.name option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.font.pathPublished video.options.addTextOverlay.overlays.font.path option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.font.sizePublished video.options.addTextOverlay.overlays.font.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fontFamilyPublished video.options.addTextOverlay.overlays.fontFamily option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fontNamePublished video.options.addTextOverlay.overlays.fontName option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fontPathPublished video.options.addTextOverlay.overlays.fontPath option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.fontSizePublished video.options.addTextOverlay.overlays.fontSize option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glowPublished video.options.addTextOverlay.overlays.glow option.Deprecated | TextGlowStyle | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.colorPublished video.options.addTextOverlay.overlays.glow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.gradientPublished video.options.addTextOverlay.overlays.glow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.gradient.colorsPublished video.options.addTextOverlay.overlays.glow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.gradient.colors.colorPublished video.options.addTextOverlay.overlays.glow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.gradient.colors.stopPublished video.options.addTextOverlay.overlays.glow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.gradient.endXPublished video.options.addTextOverlay.overlays.glow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.gradient.endYPublished video.options.addTextOverlay.overlays.glow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.gradient.pivotXPublished video.options.addTextOverlay.overlays.glow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.gradient.pivotYPublished video.options.addTextOverlay.overlays.glow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.gradient.repeatPublished video.options.addTextOverlay.overlays.glow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.gradient.rotatePublished video.options.addTextOverlay.overlays.glow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.gradient.startXPublished video.options.addTextOverlay.overlays.glow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.gradient.startYPublished video.options.addTextOverlay.overlays.glow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.gradient.typePublished video.options.addTextOverlay.overlays.glow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.gradient.endRadiusPublished video.options.addTextOverlay.overlays.glow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.gradient.startRadiusPublished video.options.addTextOverlay.overlays.glow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.gradient.centerXPublished video.options.addTextOverlay.overlays.glow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.gradient.centerYPublished video.options.addTextOverlay.overlays.glow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.gradient.startAnglePublished video.options.addTextOverlay.overlays.glow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.intensityPublished video.options.addTextOverlay.overlays.glow.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.glow.opacityPublished video.options.addTextOverlay.overlays.glow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.gradientPublished video.options.addTextOverlay.overlays.gradient option.Deprecated | gradient | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.gradient.colorsPublished video.options.addTextOverlay.overlays.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.gradient.colors.colorPublished video.options.addTextOverlay.overlays.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.gradient.colors.stopPublished video.options.addTextOverlay.overlays.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.gradient.endXPublished video.options.addTextOverlay.overlays.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.gradient.endYPublished video.options.addTextOverlay.overlays.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.gradient.pivotXPublished video.options.addTextOverlay.overlays.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.gradient.pivotYPublished video.options.addTextOverlay.overlays.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.gradient.repeatPublished video.options.addTextOverlay.overlays.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.gradient.rotatePublished video.options.addTextOverlay.overlays.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.gradient.startXPublished video.options.addTextOverlay.overlays.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.gradient.startYPublished video.options.addTextOverlay.overlays.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.gradient.typePublished video.options.addTextOverlay.overlays.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.gradient.endRadiusPublished video.options.addTextOverlay.overlays.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.gradient.startRadiusPublished video.options.addTextOverlay.overlays.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.gradient.centerXPublished video.options.addTextOverlay.overlays.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.gradient.centerYPublished video.options.addTextOverlay.overlays.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.gradient.startAnglePublished video.options.addTextOverlay.overlays.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlightPublished video.options.addTextOverlay.overlays.highlight option.Deprecated | TextHighlightStyle | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlight.colorPublished video.options.addTextOverlay.overlays.highlight.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlight.gradientPublished video.options.addTextOverlay.overlays.highlight.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlight.gradient.colorsPublished video.options.addTextOverlay.overlays.highlight.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlight.gradient.colors.colorPublished video.options.addTextOverlay.overlays.highlight.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlight.gradient.colors.stopPublished video.options.addTextOverlay.overlays.highlight.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlight.gradient.endXPublished video.options.addTextOverlay.overlays.highlight.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlight.gradient.endYPublished video.options.addTextOverlay.overlays.highlight.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlight.gradient.pivotXPublished video.options.addTextOverlay.overlays.highlight.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlight.gradient.pivotYPublished video.options.addTextOverlay.overlays.highlight.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlight.gradient.repeatPublished video.options.addTextOverlay.overlays.highlight.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlight.gradient.rotatePublished video.options.addTextOverlay.overlays.highlight.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlight.gradient.startXPublished video.options.addTextOverlay.overlays.highlight.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlight.gradient.startYPublished video.options.addTextOverlay.overlays.highlight.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlight.gradient.typePublished video.options.addTextOverlay.overlays.highlight.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlight.gradient.endRadiusPublished video.options.addTextOverlay.overlays.highlight.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlight.gradient.startRadiusPublished video.options.addTextOverlay.overlays.highlight.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlight.gradient.centerXPublished video.options.addTextOverlay.overlays.highlight.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlight.gradient.centerYPublished video.options.addTextOverlay.overlays.highlight.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlight.gradient.startAnglePublished video.options.addTextOverlay.overlays.highlight.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.highlight.opacityPublished video.options.addTextOverlay.overlays.highlight.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.includeCharMetricsPublished video.options.addTextOverlay.overlays.includeCharMetrics option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.italicPublished video.options.addTextOverlay.overlays.italic option.Deprecated | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.layoutGrouped line height, spacing, and wrap bounds (see {@link resolveTextLayout}). | TextLayout | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.layout.letterSpacingPublished video.options.addTextOverlay.overlays.layout.letterSpacing option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.layout.lineHeightPublished video.options.addTextOverlay.overlays.layout.lineHeight option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.layout.maxHeightPublished video.options.addTextOverlay.overlays.layout.maxHeight option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.layout.maxWidthPublished video.options.addTextOverlay.overlays.layout.maxWidth option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.layout.wordSpacingPublished video.options.addTextOverlay.overlays.layout.wordSpacing option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.letterSpacingPublished video.options.addTextOverlay.overlays.letterSpacing option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.lineHeightPublished video.options.addTextOverlay.overlays.lineHeight option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.maxHeightPublished video.options.addTextOverlay.overlays.maxHeight option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.maxWidthPublished video.options.addTextOverlay.overlays.maxWidth option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.measurementCanvasPublished video.options.addTextOverlay.overlays.measurementCanvas option. | { width?: number; height?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.measurementCanvas.heightPublished video.options.addTextOverlay.overlays.measurementCanvas.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.measurementCanvas.widthPublished video.options.addTextOverlay.overlays.measurementCanvas.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.opacityPublished video.options.addTextOverlay.overlays.opacity option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overlayOpacityMaster overlay opacity 0–1 (default `1`), multiplied with transition fades. Distinct from {@link TextProperties.fill} / `opacity` on glyphs. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overlinePublished video.options.addTextOverlay.overlays.overline option.Deprecated | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overline.colorPublished video.options.addTextOverlay.overlays.overline.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overline.gradientPublished video.options.addTextOverlay.overlays.overline.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overline.gradient.colorsPublished video.options.addTextOverlay.overlays.overline.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overline.gradient.colors.colorPublished video.options.addTextOverlay.overlays.overline.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overline.gradient.colors.stopPublished video.options.addTextOverlay.overlays.overline.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overline.gradient.endXPublished video.options.addTextOverlay.overlays.overline.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overline.gradient.endYPublished video.options.addTextOverlay.overlays.overline.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overline.gradient.pivotXPublished video.options.addTextOverlay.overlays.overline.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overline.gradient.pivotYPublished video.options.addTextOverlay.overlays.overline.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overline.gradient.repeatPublished video.options.addTextOverlay.overlays.overline.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overline.gradient.rotatePublished video.options.addTextOverlay.overlays.overline.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overline.gradient.startXPublished video.options.addTextOverlay.overlays.overline.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overline.gradient.startYPublished video.options.addTextOverlay.overlays.overline.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overline.gradient.typePublished video.options.addTextOverlay.overlays.overline.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overline.gradient.endRadiusPublished video.options.addTextOverlay.overlays.overline.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overline.gradient.startRadiusPublished video.options.addTextOverlay.overlays.overline.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overline.gradient.centerXPublished video.options.addTextOverlay.overlays.overline.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overline.gradient.centerYPublished video.options.addTextOverlay.overlays.overline.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overline.gradient.startAnglePublished video.options.addTextOverlay.overlays.overline.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.overline.widthPublished video.options.addTextOverlay.overlays.overline.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.placementGrouped alignment, baseline, and rotation (see {@link resolveTextPlacement}). | TextPlacement | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.placement.rotationPublished video.options.addTextOverlay.overlays.placement.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.placement.textAlignPublished video.options.addTextOverlay.overlays.placement.textAlign option. | TextAlignMode | OptionalDefault— | 5 values"center" "left" "right" "start" "end" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.placement.textBaselinePublished video.options.addTextOverlay.overlays.placement.textBaseline option. | TextBaselineMode | OptionalDefault— | 6 values"top" "bottom" "alphabetic" "hanging" "ideographic" "middle" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.rotationPublished video.options.addTextOverlay.overlays.rotation option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadowPublished video.options.addTextOverlay.overlays.shadow option.Deprecated | TextShadowStyle | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.blurPublished video.options.addTextOverlay.overlays.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.colorPublished video.options.addTextOverlay.overlays.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.gradientPublished video.options.addTextOverlay.overlays.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.gradient.colorsPublished video.options.addTextOverlay.overlays.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.gradient.colors.colorPublished video.options.addTextOverlay.overlays.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.gradient.colors.stopPublished video.options.addTextOverlay.overlays.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.gradient.endXPublished video.options.addTextOverlay.overlays.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.gradient.endYPublished video.options.addTextOverlay.overlays.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.gradient.pivotXPublished video.options.addTextOverlay.overlays.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.gradient.pivotYPublished video.options.addTextOverlay.overlays.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.gradient.repeatPublished video.options.addTextOverlay.overlays.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.gradient.rotatePublished video.options.addTextOverlay.overlays.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.gradient.startXPublished video.options.addTextOverlay.overlays.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.gradient.startYPublished video.options.addTextOverlay.overlays.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.gradient.typePublished video.options.addTextOverlay.overlays.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.gradient.endRadiusPublished video.options.addTextOverlay.overlays.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.gradient.startRadiusPublished video.options.addTextOverlay.overlays.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.gradient.centerXPublished video.options.addTextOverlay.overlays.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.gradient.centerYPublished video.options.addTextOverlay.overlays.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.gradient.startAnglePublished video.options.addTextOverlay.overlays.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.offsetXPublished video.options.addTextOverlay.overlays.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.offsetYPublished video.options.addTextOverlay.overlays.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.shadow.opacityPublished video.options.addTextOverlay.overlays.shadow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.startTimeSeconds when this overlay becomes visible. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethroughPublished video.options.addTextOverlay.overlays.strikethrough option.Deprecated | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethrough.colorPublished video.options.addTextOverlay.overlays.strikethrough.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethrough.gradientPublished video.options.addTextOverlay.overlays.strikethrough.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethrough.gradient.colorsPublished video.options.addTextOverlay.overlays.strikethrough.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethrough.gradient.colors.colorPublished video.options.addTextOverlay.overlays.strikethrough.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethrough.gradient.colors.stopPublished video.options.addTextOverlay.overlays.strikethrough.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethrough.gradient.endXPublished video.options.addTextOverlay.overlays.strikethrough.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethrough.gradient.endYPublished video.options.addTextOverlay.overlays.strikethrough.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethrough.gradient.pivotXPublished video.options.addTextOverlay.overlays.strikethrough.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethrough.gradient.pivotYPublished video.options.addTextOverlay.overlays.strikethrough.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethrough.gradient.repeatPublished video.options.addTextOverlay.overlays.strikethrough.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethrough.gradient.rotatePublished video.options.addTextOverlay.overlays.strikethrough.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethrough.gradient.startXPublished video.options.addTextOverlay.overlays.strikethrough.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethrough.gradient.startYPublished video.options.addTextOverlay.overlays.strikethrough.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethrough.gradient.typePublished video.options.addTextOverlay.overlays.strikethrough.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethrough.gradient.endRadiusPublished video.options.addTextOverlay.overlays.strikethrough.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethrough.gradient.startRadiusPublished video.options.addTextOverlay.overlays.strikethrough.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethrough.gradient.centerXPublished video.options.addTextOverlay.overlays.strikethrough.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethrough.gradient.centerYPublished video.options.addTextOverlay.overlays.strikethrough.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethrough.gradient.startAnglePublished video.options.addTextOverlay.overlays.strikethrough.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strikethrough.widthPublished video.options.addTextOverlay.overlays.strikethrough.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.strokePublished video.options.addTextOverlay.overlays.stroke option. | TextStrokeStyle | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.colorPublished video.options.addTextOverlay.overlays.stroke.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.gradientPublished video.options.addTextOverlay.overlays.stroke.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.gradient.colorsPublished video.options.addTextOverlay.overlays.stroke.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.gradient.colors.colorPublished video.options.addTextOverlay.overlays.stroke.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.gradient.colors.stopPublished video.options.addTextOverlay.overlays.stroke.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.gradient.endXPublished video.options.addTextOverlay.overlays.stroke.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.gradient.endYPublished video.options.addTextOverlay.overlays.stroke.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.gradient.pivotXPublished video.options.addTextOverlay.overlays.stroke.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.gradient.pivotYPublished video.options.addTextOverlay.overlays.stroke.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.gradient.repeatPublished video.options.addTextOverlay.overlays.stroke.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.gradient.rotatePublished video.options.addTextOverlay.overlays.stroke.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.gradient.startXPublished video.options.addTextOverlay.overlays.stroke.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.gradient.startYPublished video.options.addTextOverlay.overlays.stroke.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.gradient.typePublished video.options.addTextOverlay.overlays.stroke.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.gradient.endRadiusPublished video.options.addTextOverlay.overlays.stroke.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.gradient.startRadiusPublished video.options.addTextOverlay.overlays.stroke.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.gradient.centerXPublished video.options.addTextOverlay.overlays.stroke.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.gradient.centerYPublished video.options.addTextOverlay.overlays.stroke.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.gradient.startAnglePublished video.options.addTextOverlay.overlays.stroke.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.opacityPublished video.options.addTextOverlay.overlays.stroke.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.stylePublished video.options.addTextOverlay.overlays.stroke.style option. | "solid" | "dashed" | "dotted" | "groove" | "ridge" | "double" | OptionalDefault— | 6 values"solid" "dashed" "dotted" "groove" "ridge" "double" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.stroke.widthPublished video.options.addTextOverlay.overlays.stroke.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.textPublished video.options.addTextOverlay.overlays.text option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.textAlignPublished video.options.addTextOverlay.overlays.textAlign option.Deprecated | TextAlignMode | OptionalDefault— | 5 values"center" "left" "right" "start" "end" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.textBaselinePublished video.options.addTextOverlay.overlays.textBaseline option.Deprecated | TextBaselineMode | OptionalDefault— | 6 values"top" "bottom" "alphabetic" "hanging" "ideographic" "middle" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.textOnCurvePublished video.options.addTextOverlay.overlays.textOnCurve option.Deprecated | TextCurveConfig | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.textOnCurve.baselineOffsetPublished video.options.addTextOverlay.overlays.textOnCurve.baselineOffset option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.textOnCurve.layoutModePublished video.options.addTextOverlay.overlays.textOnCurve.layoutMode option. | CurvedTextLayoutMode | OptionalDefault— | "fit" "clamp" "override" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.textOnCurve.radiusPublished video.options.addTextOverlay.overlays.textOnCurve.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.textOnCurve.startAngleDegPublished video.options.addTextOverlay.overlays.textOnCurve.startAngleDeg option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.textOnCurve.sweepAnglePublished video.options.addTextOverlay.overlays.textOnCurve.sweepAngle option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.textOnCurve.upPublished video.options.addTextOverlay.overlays.textOnCurve.up option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.transitionInPublished video.options.addTextOverlay.overlays.transitionIn option. | VideoTextTransition | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.transitionIn.customAdvanced: override auto-built expressions (`t` variable, main video `w`/`h`). When set, merged with preset (preset fills missing keys). | { x?: string; y?: string; alpha?: string; scale?: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.transitionIn.custom.alphaPublished video.options.addTextOverlay.overlays.transitionIn.custom.alpha option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.transitionIn.custom.scalePublished video.options.addTextOverlay.overlays.transitionIn.custom.scale option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.transitionIn.custom.xPublished video.options.addTextOverlay.overlays.transitionIn.custom.x option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.transitionIn.custom.yPublished video.options.addTextOverlay.overlays.transitionIn.custom.y option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.transitionIn.durationSeconds (default `0.35`). | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.transitionIn.typePublished video.options.addTextOverlay.overlays.transitionIn.type option. | VideoTextTransitionPreset | RequiredDefaultRequired | 14 values"none" "fade" "fadeIn" "fadeOut" "slideIn" "slideOut" "slideLeft" "slideRight" "slideUp" "slideDown" "zoomIn" "zoomOut" "bounce" "typewriter" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.transitionOutPublished video.options.addTextOverlay.overlays.transitionOut option. | VideoTextTransition | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.transitionOut.customAdvanced: override auto-built expressions (`t` variable, main video `w`/`h`). When set, merged with preset (preset fills missing keys). | { x?: string; y?: string; alpha?: string; scale?: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.transitionOut.custom.alphaPublished video.options.addTextOverlay.overlays.transitionOut.custom.alpha option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.transitionOut.custom.scalePublished video.options.addTextOverlay.overlays.transitionOut.custom.scale option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.transitionOut.custom.xPublished video.options.addTextOverlay.overlays.transitionOut.custom.x option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.transitionOut.custom.yPublished video.options.addTextOverlay.overlays.transitionOut.custom.y option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.transitionOut.durationSeconds (default `0.35`). | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.transitionOut.typePublished video.options.addTextOverlay.overlays.transitionOut.type option. | VideoTextTransitionPreset | RequiredDefaultRequired | 14 values"none" "fade" "fadeIn" "fadeOut" "slideIn" "slideOut" "slideLeft" "slideRight" "slideUp" "slideDown" "zoomIn" "zoomOut" "bounce" "typewriter" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underlinePublished video.options.addTextOverlay.overlays.underline option.Deprecated | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underline.colorPublished video.options.addTextOverlay.overlays.underline.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underline.gradientPublished video.options.addTextOverlay.overlays.underline.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underline.gradient.colorsPublished video.options.addTextOverlay.overlays.underline.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underline.gradient.colors.colorPublished video.options.addTextOverlay.overlays.underline.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underline.gradient.colors.stopPublished video.options.addTextOverlay.overlays.underline.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underline.gradient.endXPublished video.options.addTextOverlay.overlays.underline.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underline.gradient.endYPublished video.options.addTextOverlay.overlays.underline.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underline.gradient.pivotXPublished video.options.addTextOverlay.overlays.underline.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underline.gradient.pivotYPublished video.options.addTextOverlay.overlays.underline.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underline.gradient.repeatPublished video.options.addTextOverlay.overlays.underline.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underline.gradient.rotatePublished video.options.addTextOverlay.overlays.underline.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underline.gradient.startXPublished video.options.addTextOverlay.overlays.underline.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underline.gradient.startYPublished video.options.addTextOverlay.overlays.underline.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underline.gradient.typePublished video.options.addTextOverlay.overlays.underline.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underline.gradient.endRadiusPublished video.options.addTextOverlay.overlays.underline.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underline.gradient.startRadiusPublished video.options.addTextOverlay.overlays.underline.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underline.gradient.centerXPublished video.options.addTextOverlay.overlays.underline.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underline.gradient.centerYPublished video.options.addTextOverlay.overlays.underline.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underline.gradient.startAnglePublished video.options.addTextOverlay.overlays.underline.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.underline.widthPublished video.options.addTextOverlay.overlays.underline.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.wordSpacingPublished video.options.addTextOverlay.overlays.wordSpacing option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.xPublished video.options.addTextOverlay.overlays.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTextOverlay.overlays.yPublished video.options.addTextOverlay.overlays.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTransitionPublished video.options.addTransition option. | { type: "circle" | "blur" | "zoom" | "fade" | "wipe" | "slide" | "rotate" | "dissolve" | "pixelize"; duration: number; direction?: "left" | "right" | "up" | "down" | "in" | "out"; secondVideo?: VideoSource; outputPath: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTransition.directionPublished video.options.addTransition.direction option. | "left" | "right" | "up" | "down" | "in" | "out" | OptionalDefault— | 6 values"left" "right" "up" "down" "in" "out" | node22 · node24 · node26 |
video.options.addTransition.durationPublished video.options.addTransition.duration option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTransition.outputPathPublished video.options.addTransition.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addTransition.secondVideoPublished video.options.addTransition.secondVideo option. | VideoSource | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addTransition.typePublished video.options.addTransition.type option. | "circle" | "blur" | "zoom" | "fade" | "wipe" | "slide" | "rotate" | "dissolve" | "pixelize" | RequiredDefaultRequired | 9 values"circle" "blur" "zoom" "fade" "wipe" "slide" "rotate" "dissolve" "pixelize" | node22 · node24 · node26 |
video.options.addWatermarkPublished video.options.addWatermark option. | { watermarkPath: VideoSource; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"; opacity?: number; size?: { width?: number; height?: number; fit?: VideoFit; }; marginX?: number; marginY?: number; startTime?: number; endTime?: number; outputPath: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addWatermark.endTimePublished video.options.addWatermark.endTime option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addWatermark.marginXPublished video.options.addWatermark.marginX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addWatermark.marginYPublished video.options.addWatermark.marginY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addWatermark.opacityPublished video.options.addWatermark.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addWatermark.outputPathPublished video.options.addWatermark.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.addWatermark.positionPublished video.options.addWatermark.position option. | "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | OptionalDefault— | 5 values"center" "top-left" "top-right" "bottom-left" "bottom-right" | node22 · node24 · node26 |
video.options.addWatermark.sizePublished video.options.addWatermark.size option. | { width?: number; height?: number; fit?: VideoFit; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addWatermark.size.fitPublished video.options.addWatermark.size.fit option. | VideoFit | OptionalDefault— | "contain" "cover" "stretch" | node22 · node24 · node26 |
video.options.addWatermark.size.heightPublished video.options.addWatermark.size.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addWatermark.size.widthPublished video.options.addWatermark.size.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addWatermark.startTimePublished video.options.addWatermark.startTime option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.addWatermark.watermarkPathPublished video.options.addWatermark.watermarkPath option. | VideoSource | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.adjustVolumePublished video.options.adjustVolume option. | { outputPath: string; volume?: number; ranges?: { start: number; end: number; volume: number; speed?: number; pitchSemitones?: number; }[]; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.adjustVolume.outputPathPublished video.options.adjustVolume.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.adjustVolume.rangesPublished video.options.adjustVolume.ranges option. | { start: number; end: number; volume: number; speed?: number; pitchSemitones?: number; }[] | OptionalDefault— | — | node22 · node24 · node26 |
video.options.adjustVolume.ranges.endPublished video.options.adjustVolume.ranges.end option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.adjustVolume.ranges.pitchSemitonesPublished video.options.adjustVolume.ranges.pitchSemitones option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.adjustVolume.ranges.speedPublished video.options.adjustVolume.ranges.speed option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.adjustVolume.ranges.startPublished video.options.adjustVolume.ranges.start option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.adjustVolume.ranges.volumePublished video.options.adjustVolume.ranges.volume option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.adjustVolume.volumePublished video.options.adjustVolume.volume option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.applyEffectsPublished video.options.applyEffects option. | { filters: { type: "saturation" | "sharpen" | "noise" | "invert" | "grayscale" | "sepia" | "brightness" | "contrast" | "blur"; intensity?: number; value?: number; }[]; outputPath: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.applyEffects.filtersPublished video.options.applyEffects.filters option. | { type: "saturation" | "sharpen" | "noise" | "invert" | "grayscale" | "sepia" | "brightness" | "contrast" | "blur"; intensity?: number; value?: number; }[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.applyEffects.filters.intensityPublished video.options.applyEffects.filters.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.applyEffects.filters.typePublished video.options.applyEffects.filters.type option. | "saturation" | "sharpen" | "noise" | "invert" | "grayscale" | "sepia" | "brightness" | "contrast" | "blur" | RequiredDefaultRequired | 9 values"saturation" "sharpen" "noise" "invert" "grayscale" "sepia" "brightness" "contrast" "blur" | node22 · node24 · node26 |
video.options.applyEffects.filters.valuePublished video.options.applyEffects.filters.value option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.applyEffects.outputPathPublished video.options.applyEffects.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.applyLUTPublished video.options.applyLUT option. | { lutPath: string; intensity?: number; outputPath: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.applyLUT.intensityPublished video.options.applyLUT.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.applyLUT.lutPathPublished video.options.applyLUT.lutPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.applyLUT.outputPathPublished video.options.applyLUT.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.batchPublished video.options.batch option. | { videos: { source: VideoSource; operations: Record<string, unknown>; }[]; outputDirectory: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.batch.outputDirectoryPublished video.options.batch.outputDirectory option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.batch.videosPublished video.options.batch.videos option. | { source: VideoSource; operations: Record<string, unknown>; }[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.batch.videos.operationsPublished video.options.batch.videos.operations option. | Record<string, unknown> | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.batch.videos.sourcePublished video.options.batch.videos.source option. | VideoSource | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.changeSpeedPublished video.options.changeSpeed option. | { speed: number; outputPath: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.changeSpeed.outputPathPublished video.options.changeSpeed.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.changeSpeed.speedPublished video.options.changeSpeed.speed option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.colorCorrectPublished video.options.colorCorrect option. | { brightness?: number; contrast?: number; saturation?: number; hue?: number; temperature?: number; outputPath: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.colorCorrect.brightnessPublished video.options.colorCorrect.brightness option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.colorCorrect.contrastPublished video.options.colorCorrect.contrast option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.colorCorrect.huePublished video.options.colorCorrect.hue option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.colorCorrect.outputPathPublished video.options.colorCorrect.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.colorCorrect.saturationPublished video.options.colorCorrect.saturation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.colorCorrect.temperaturePublished video.options.colorCorrect.temperature option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.compressPublished video.options.compress option. | { outputPath: string; quality?: VideoQuality; targetSize?: number; maxBitrate?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.compress.maxBitratePublished video.options.compress.maxBitrate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.compress.outputPathPublished video.options.compress.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.compress.qualityPublished video.options.compress.quality option. | VideoQuality | OptionalDefault— | "low" "medium" "high" "ultra" | node22 · node24 · node26 |
video.options.compress.targetSizePublished video.options.compress.targetSize option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.convertPublished video.options.convert option. | { outputPath: string; format?: VideoOutputFormat; videoCodec?: "copy" | "libx264" | "libx265" | "libvpx-vp9" | "libaom-av1"; audioCodec?: "copy" | "none" | "aac" | "libopus" | "libvorbis" | "mp3"; pixelFormat?: "yuv420p" | "yuv422p" | "yuv444p" | "rgba"; quality?: VideoQuality; bitrate?: number; fps?: number; resolution?: { width?: number; height?: number; fit?: VideoFit; }; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.convert.audioCodecPublished video.options.convert.audioCodec option. | "copy" | "none" | "aac" | "libopus" | "libvorbis" | "mp3" | OptionalDefault— | 6 values"copy" "none" "aac" "libopus" "libvorbis" "mp3" | node22 · node24 · node26 |
video.options.convert.bitratePublished video.options.convert.bitrate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.convert.formatPublished video.options.convert.format option. | VideoOutputFormat | OptionalDefault— | 5 values"mp4" "webm" "avi" "mov" "mkv" | node22 · node24 · node26 |
video.options.convert.fpsPublished video.options.convert.fps option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.convert.outputPathPublished video.options.convert.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.convert.pixelFormatPublished video.options.convert.pixelFormat option. | "yuv420p" | "yuv422p" | "yuv444p" | "rgba" | OptionalDefault— | "yuv420p" "yuv422p" "yuv444p" "rgba" | node22 · node24 · node26 |
video.options.convert.qualityPublished video.options.convert.quality option. | VideoQuality | OptionalDefault— | "low" "medium" "high" "ultra" | node22 · node24 · node26 |
video.options.convert.resolutionPublished video.options.convert.resolution option. | { width?: number; height?: number; fit?: VideoFit; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.convert.resolution.fitPublished video.options.convert.resolution.fit option. | VideoFit | OptionalDefault— | "contain" "cover" "stretch" | node22 · node24 · node26 |
video.options.convert.resolution.heightPublished video.options.convert.resolution.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.convert.resolution.widthPublished video.options.convert.resolution.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.convert.videoCodecPublished video.options.convert.videoCodec option. | "copy" | "libx264" | "libx265" | "libvpx-vp9" | "libaom-av1" | OptionalDefault— | 5 values"copy" "libx264" "libx265" "libvpx-vp9" "libaom-av1" | node22 · node24 · node26 |
video.options.createFromFramesPublished video.options.createFromFrames option. | { frames: VideoSource[]; outputPath: string; fps?: number; format?: VideoOutputFormat; quality?: VideoQuality; bitrate?: number; resolution?: { width?: number; height?: number; fit?: VideoFit; }; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.createFromFrames.bitratePublished video.options.createFromFrames.bitrate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.createFromFrames.formatPublished video.options.createFromFrames.format option. | VideoOutputFormat | OptionalDefault— | 5 values"mp4" "webm" "avi" "mov" "mkv" | node22 · node24 · node26 |
video.options.createFromFrames.fpsPublished video.options.createFromFrames.fps option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.createFromFrames.framesPublished video.options.createFromFrames.frames option. | VideoSource[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.createFromFrames.outputPathPublished video.options.createFromFrames.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.createFromFrames.qualityPublished video.options.createFromFrames.quality option. | VideoQuality | OptionalDefault— | "low" "medium" "high" "ultra" | node22 · node24 · node26 |
video.options.createFromFrames.resolutionPublished video.options.createFromFrames.resolution option. | { width?: number; height?: number; fit?: VideoFit; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.createFromFrames.resolution.fitPublished video.options.createFromFrames.resolution.fit option. | VideoFit | OptionalDefault— | "contain" "cover" "stretch" | node22 · node24 · node26 |
video.options.createFromFrames.resolution.heightPublished video.options.createFromFrames.resolution.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.createFromFrames.resolution.widthPublished video.options.createFromFrames.resolution.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.createLoopPublished video.options.createLoop option. | { outputPath: string; smooth?: boolean; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.createLoop.outputPathPublished video.options.createLoop.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.createLoop.smoothPublished video.options.createLoop.smooth option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
video.options.createTimeLapsePublished video.options.createTimeLapse option. | { speed?: number; outputPath: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.createTimeLapse.outputPathPublished video.options.createTimeLapse.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.createTimeLapse.speedPublished video.options.createTimeLapse.speed option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.cropPublished video.options.crop option. | { x: number; y: number; width: number; height: number; outputPath: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.crop.heightPublished video.options.crop.height option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.crop.outputPathPublished video.options.crop.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.crop.widthPublished video.options.crop.width option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.crop.xPublished video.options.crop.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.crop.yPublished video.options.crop.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.detectFormatPublished video.options.detectFormat option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
video.options.detectScenesPublished video.options.detectScenes option. | { threshold?: number; outputPath?: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.detectScenes.outputPathPublished video.options.detectScenes.outputPath option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.detectScenes.thresholdPublished video.options.detectScenes.threshold option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.exportPresetPublished video.options.exportPreset option. | { preset: "youtube" | "instagram" | "tiktok" | "twitter" | "facebook" | "4k" | "1080p" | "720p" | "mobile" | "web"; outputPath: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.exportPreset.outputPathPublished video.options.exportPreset.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.exportPreset.presetPublished video.options.exportPreset.preset option. | "youtube" | "instagram" | "tiktok" | "twitter" | "facebook" | "4k" | "1080p" | "720p" | "mobile" | "web" | RequiredDefaultRequired | 10 values"youtube" "instagram" "tiktok" "twitter" "facebook" "4k" "1080p" "720p" "mobile" "web" | node22 · node24 · node26 |
video.options.extractAllFramesPublished video.options.extractAllFrames option. | { outputFormat?: "jpg" | "png"; outputDirectory?: string; quality?: number; prefix?: string; startTime?: number; endTime?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractAllFrames.endTimePublished video.options.extractAllFrames.endTime option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractAllFrames.outputDirectoryPublished video.options.extractAllFrames.outputDirectory option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractAllFrames.outputFormatPublished video.options.extractAllFrames.outputFormat option. | "jpg" | "png" | OptionalDefault— | "jpg" "png" | node22 · node24 · node26 |
video.options.extractAllFrames.prefixPublished video.options.extractAllFrames.prefix option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractAllFrames.qualityPublished video.options.extractAllFrames.quality option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractAllFrames.startTimePublished video.options.extractAllFrames.startTime option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractAudioPublished video.options.extractAudio option. | { outputPath: string; format?: "aac" | "mp3" | "wav" | "ogg"; bitrate?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractAudio.bitratePublished video.options.extractAudio.bitrate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractAudio.formatPublished video.options.extractAudio.format option. | "aac" | "mp3" | "wav" | "ogg" | OptionalDefault— | "aac" "mp3" "wav" "ogg" | node22 · node24 · node26 |
video.options.extractAudio.outputPathPublished video.options.extractAudio.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.extractFramePublished video.options.extractFrame option. | { time?: number; frame?: number; width?: number; height?: number; outputFormat?: "jpg" | "png"; quality?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractFrame.framePublished video.options.extractFrame.frame option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractFrame.heightPublished video.options.extractFrame.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractFrame.outputFormatPublished video.options.extractFrame.outputFormat option. | "jpg" | "png" | OptionalDefault— | "jpg" "png" | node22 · node24 · node26 |
video.options.extractFrame.qualityPublished video.options.extractFrame.quality option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractFrame.timePublished video.options.extractFrame.time option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractFrame.widthPublished video.options.extractFrame.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractFramesPublished video.options.extractFrames option. | { times?: number[]; interval?: number; frameSelection?: { start?: number; end?: number; }; outputFormat?: "jpg" | "png"; quality?: number; outputDirectory?: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractFrames.frameSelectionPublished video.options.extractFrames.frameSelection option. | { start?: number; end?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractFrames.frameSelection.endPublished video.options.extractFrames.frameSelection.end option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractFrames.frameSelection.startPublished video.options.extractFrames.frameSelection.start option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractFrames.intervalPublished video.options.extractFrames.interval option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractFrames.outputDirectoryPublished video.options.extractFrames.outputDirectory option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractFrames.outputFormatPublished video.options.extractFrames.outputFormat option. | "jpg" | "png" | OptionalDefault— | "jpg" "png" | node22 · node24 · node26 |
video.options.extractFrames.qualityPublished video.options.extractFrames.quality option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.extractFrames.timesPublished video.options.extractFrames.times option. | number[] | OptionalDefault— | — | node22 · node24 · node26 |
video.options.freezeFramePublished video.options.freezeFrame option. | { time: number; duration: number; outputPath: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.freezeFrame.durationPublished video.options.freezeFrame.duration option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.freezeFrame.outputPathPublished video.options.freezeFrame.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.freezeFrame.timePublished video.options.freezeFrame.time option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.generatePreviewPublished video.options.generatePreview option. | { count?: number; outputDirectory?: string; outputFormat?: "jpg" | "png"; quality?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.generatePreview.countPublished video.options.generatePreview.count option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.generatePreview.outputDirectoryPublished video.options.generatePreview.outputDirectory option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.generatePreview.outputFormatPublished video.options.generatePreview.outputFormat option. | "jpg" | "png" | OptionalDefault— | "jpg" "png" | node22 · node24 · node26 |
video.options.generatePreview.qualityPublished video.options.generatePreview.quality option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.generateThumbnailPublished video.options.generateThumbnail option. | { count?: number; grid?: { cols: number; rows: number; }; width?: number; height?: number; outputFormat?: "jpg" | "png"; quality?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.generateThumbnail.countPublished video.options.generateThumbnail.count option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.generateThumbnail.gridPublished video.options.generateThumbnail.grid option. | { cols: number; rows: number; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.generateThumbnail.grid.colsPublished video.options.generateThumbnail.grid.cols option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.generateThumbnail.grid.rowsPublished video.options.generateThumbnail.grid.rows option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.generateThumbnail.heightPublished video.options.generateThumbnail.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.generateThumbnail.outputFormatPublished video.options.generateThumbnail.outputFormat option. | "jpg" | "png" | OptionalDefault— | "jpg" "png" | node22 · node24 · node26 |
video.options.generateThumbnail.qualityPublished video.options.generateThumbnail.quality option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.generateThumbnail.widthPublished video.options.generateThumbnail.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.getInfoPublished video.options.getInfo option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
video.options.mergePublished video.options.merge option. | { videos: VideoSource[]; outputPath: string; mode?: "grid" | "sequential" | "side-by-side"; direction?: "horizontal" | "vertical"; grid?: { cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }; audioPolicy?: VideoAudioPolicy; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.merge.audioPolicyPublished video.options.merge.audioPolicy option. | VideoAudioPolicy | OptionalDefault— | "none" "preserve" "first" "mix" | node22 · node24 · node26 |
video.options.merge.directionPublished video.options.merge.direction option. | "horizontal" | "vertical" | OptionalDefault— | "horizontal" "vertical" | node22 · node24 · node26 |
video.options.merge.gridPublished video.options.merge.grid option. | { cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.merge.grid.backgroundPublished video.options.merge.grid.background option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.merge.grid.cellHeightPublished video.options.merge.grid.cellHeight option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.merge.grid.cellWidthPublished video.options.merge.grid.cellWidth option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.merge.grid.colsPublished video.options.merge.grid.cols option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.merge.grid.gapPublished video.options.merge.grid.gap option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.merge.grid.rowsPublished video.options.merge.grid.rows option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.merge.modePublished video.options.merge.mode option. | "grid" | "sequential" | "side-by-side" | OptionalDefault— | "grid" "sequential" "side-by-side" | node22 · node24 · node26 |
video.options.merge.outputPathPublished video.options.merge.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.merge.videosPublished video.options.merge.videos option. | VideoSource[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.mixAudioPublished video.options.mixAudio option. | MixAudioOperation | OptionalDefault— | — | node22 · node24 · node26 |
video.options.mixAudio.durationPolicyOutput length policy. `video` is the stable default. | "video" | "shortest" | "longest" | OptionalDefault— | "video" "shortest" "longest" | node22 · node24 · node26 |
video.options.mixAudio.keepOriginalAudioPublished video.options.mixAudio.keepOriginalAudio option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
video.options.mixAudio.originalPitchSemitonesPublished video.options.mixAudio.originalPitchSemitones option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.mixAudio.originalSpeedPublished video.options.mixAudio.originalSpeed option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.mixAudio.originalVolumePublished video.options.mixAudio.originalVolume option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.mixAudio.outputPathPublished video.options.mixAudio.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.mixAudio.overlaysPublished video.options.mixAudio.overlays option. | MixAudioOverlayClip[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.mixAudio.overlays.durationPublished video.options.mixAudio.overlays.duration option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.mixAudio.overlays.fadeInPublished video.options.mixAudio.overlays.fadeIn option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.mixAudio.overlays.fadeOutPublished video.options.mixAudio.overlays.fadeOut option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.mixAudio.overlays.panStereo pan from -1 (left) to +1 (right). | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.mixAudio.overlays.pitchSemitonesPublished video.options.mixAudio.overlays.pitchSemitones option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.mixAudio.overlays.sourcePublished video.options.mixAudio.overlays.source option. | VideoSource | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.mixAudio.overlays.sourceStartPublished video.options.mixAudio.overlays.sourceStart option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.mixAudio.overlays.speedPublished video.options.mixAudio.overlays.speed option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.mixAudio.overlays.startTimePublished video.options.mixAudio.overlays.startTime option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.mixAudio.overlays.volumePublished video.options.mixAudio.overlays.volume option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.mutePublished video.options.mute option. | { outputPath: string; ranges?: { start: number; end: number; }[]; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.mute.outputPathPublished video.options.mute.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.mute.rangesPublished video.options.mute.ranges option. | { start: number; end: number; }[] | OptionalDefault— | — | node22 · node24 · node26 |
video.options.mute.ranges.endPublished video.options.mute.ranges.end option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.mute.ranges.startPublished video.options.mute.ranges.start option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.normalizeAudioPublished video.options.normalizeAudio option. | { targetLevel?: number; method?: "peak" | "rms" | "lufs"; outputPath: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.normalizeAudio.methodPublished video.options.normalizeAudio.method option. | "peak" | "rms" | "lufs" | OptionalDefault— | "peak" "rms" "lufs" | node22 · node24 · node26 |
video.options.normalizeAudio.outputPathPublished video.options.normalizeAudio.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.normalizeAudio.targetLevelPublished video.options.normalizeAudio.targetLevel option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.onProgressPublished video.options.onProgress option. | (progress: FfmpegProgress) => void | OptionalDefault— | — | node22 · node24 · node26 |
video.options.overwriteExisting output policy. Defaults to true for backward compatibility. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
video.options.pictureInPicturePublished video.options.pictureInPicture option. | { overlayVideo: VideoSource; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"; size?: { width?: number; height?: number; fit?: VideoFit; }; opacity?: number; outputPath: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.pictureInPicture.opacityPublished video.options.pictureInPicture.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.pictureInPicture.outputPathPublished video.options.pictureInPicture.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.pictureInPicture.overlayVideoPublished video.options.pictureInPicture.overlayVideo option. | VideoSource | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.pictureInPicture.positionPublished video.options.pictureInPicture.position option. | "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | OptionalDefault— | 5 values"center" "top-left" "top-right" "bottom-left" "bottom-right" | node22 · node24 · node26 |
video.options.pictureInPicture.sizePublished video.options.pictureInPicture.size option. | { width?: number; height?: number; fit?: VideoFit; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.pictureInPicture.size.fitPublished video.options.pictureInPicture.size.fit option. | VideoFit | OptionalDefault— | "contain" "cover" "stretch" | node22 · node24 · node26 |
video.options.pictureInPicture.size.heightPublished video.options.pictureInPicture.size.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.pictureInPicture.size.widthPublished video.options.pictureInPicture.size.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.removeAudioPublished video.options.removeAudio option. | { outputPath: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.removeAudio.outputPathPublished video.options.removeAudio.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.replaceSegmentPublished video.options.replaceSegment option. | { replacementVideo?: VideoSource; replacementStartTime?: number; replacementDuration?: number; replacementFrames?: VideoSource[]; replacementFps?: number; targetStartTime: number; targetEndTime: number; durationPolicy?: "fit" | "preserve" | "trim"; outputPath: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.replaceSegment.durationPolicyfit scales replacement time to the target span; trim truncates/pads; preserve changes total duration. | "fit" | "preserve" | "trim" | OptionalDefault— | "fit" "preserve" "trim" | node22 · node24 · node26 |
video.options.replaceSegment.outputPathPublished video.options.replaceSegment.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.replaceSegment.replacementDurationPublished video.options.replaceSegment.replacementDuration option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.replaceSegment.replacementFpsPublished video.options.replaceSegment.replacementFps option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.replaceSegment.replacementFramesPublished video.options.replaceSegment.replacementFrames option. | VideoSource[] | OptionalDefault— | — | node22 · node24 · node26 |
video.options.replaceSegment.replacementStartTimePublished video.options.replaceSegment.replacementStartTime option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.replaceSegment.replacementVideoPublished video.options.replaceSegment.replacementVideo option. | VideoSource | OptionalDefault— | — | node22 · node24 · node26 |
video.options.replaceSegment.targetEndTimePublished video.options.replaceSegment.targetEndTime option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.replaceSegment.targetStartTimePublished video.options.replaceSegment.targetStartTime option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.reversePublished video.options.reverse option. | { outputPath: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.reverse.outputPathPublished video.options.reverse.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.rotatePublished video.options.rotate option. | { angle?: 90 | 180 | 270; flip?: "horizontal" | "vertical" | "both"; outputPath: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.rotate.anglePublished video.options.rotate.angle option. | 90 | 180 | 270 | OptionalDefault— | 90 180 270 | node22 · node24 · node26 |
video.options.rotate.flipPublished video.options.rotate.flip option. | "horizontal" | "vertical" | "both" | OptionalDefault— | "horizontal" "vertical" "both" | node22 · node24 · node26 |
video.options.rotate.outputPathPublished video.options.rotate.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.signalAbort remote resolution and the active FFmpeg/ffprobe process. | AbortSignal | OptionalDefault— | — | node22 · node24 · node26 |
video.options.sourcePublished video.options.source option. | VideoSource | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.splitScreenPublished video.options.splitScreen option. | { videos: VideoSource[]; layout?: "grid" | "side-by-side" | "top-bottom"; grid?: { cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }; audioPolicy?: VideoAudioPolicy; outputPath: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.splitScreen.audioPolicyPublished video.options.splitScreen.audioPolicy option. | VideoAudioPolicy | OptionalDefault— | "none" "preserve" "first" "mix" | node22 · node24 · node26 |
video.options.splitScreen.gridPublished video.options.splitScreen.grid option. | { cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.splitScreen.grid.backgroundPublished video.options.splitScreen.grid.background option. | string | OptionalDefault— | — | node22 · node24 · node26 |
video.options.splitScreen.grid.cellHeightPublished video.options.splitScreen.grid.cellHeight option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.splitScreen.grid.cellWidthPublished video.options.splitScreen.grid.cellWidth option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.splitScreen.grid.colsPublished video.options.splitScreen.grid.cols option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.splitScreen.grid.gapPublished video.options.splitScreen.grid.gap option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.splitScreen.grid.rowsPublished video.options.splitScreen.grid.rows option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.splitScreen.layoutPublished video.options.splitScreen.layout option. | "grid" | "side-by-side" | "top-bottom" | OptionalDefault— | "grid" "side-by-side" "top-bottom" | node22 · node24 · node26 |
video.options.splitScreen.outputPathPublished video.options.splitScreen.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.splitScreen.videosPublished video.options.splitScreen.videos option. | VideoSource[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.stabilizePublished video.options.stabilize option. | { outputPath: string; smoothing?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.stabilize.outputPathPublished video.options.stabilize.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.stabilize.smoothingPublished video.options.stabilize.smoothing option. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.timeoutMsPer-operation process timeout. Defaults to runtime FFmpeg policy. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.options.trimAccurate mode re-encodes for timestamp precision; copy mode is keyframe-bound. | { startTime: number; endTime: number; outputPath: string; mode?: "copy" | "accurate"; } | OptionalDefault— | — | node22 · node24 · node26 |
video.options.trim.endTimePublished video.options.trim.endTime option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.trim.modePublished video.options.trim.mode option. | "copy" | "accurate" | OptionalDefault— | "copy" "accurate" | node22 · node24 · node26 |
video.options.trim.outputPathPublished video.options.trim.outputPath option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.options.trim.startTimePublished video.options.trim.startTime option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
video.prependComposedToFramesPublished video.prependComposedToFrames option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
video.sceneRenderPublished video.sceneRender option. | SceneRenderOptions | OptionalDefault— | — | node22 · node24 · node26 |
video.sceneRender.maxSurfaceDepthOptional stricter surface depth cap. It may not exceed the configured runtime `maxSceneDepth`. | number | OptionalDefault— | — | node22 · node24 · node26 |
video.sceneRender.resolveAssetRefsResolve `$name`/`$value.path` asset tokens before painting. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
video.sceneRender.validatePublished video.sceneRender.validate option.Deprecated | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
scene.background
OptionalRoot paint configuration only; root dimensions are always `width`/`height`.
- Type
SceneBackground- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.bgLayers
OptionalPublished scene.background.bgLayers option.
- Type
BackgroundLayer[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.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
Published scene.background.bgLayers.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.bgLayers.type
RequiredPublished scene.background.bgLayers.type option.
- Type
"color"- Default
- Required
- Allowed
"color"- Runtime
- node22, node24, node26
scene.background.bgLayers.value
RequiredPublished scene.background.bgLayers.value option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.bgLayers.align
OptionalPublished scene.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
scene.background.bgLayers.fit
OptionalPublished scene.background.bgLayers.fit option.
- Type
"fill" | "contain" | "cover"- Default
- —
- Allowed
"fill""contain""cover"- Runtime
- node22, node24, node26
scene.background.bgLayers.source
RequiredPublished scene.background.bgLayers.source option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.bgLayers.repeat
OptionalPublished scene.background.bgLayers.repeat option.
- Type
BackgroundPatternRepeat- Default
- —
- Allowed
"repeat""no-repeat""repeat-x""repeat-y"- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern option.
- Type
PatternOptions- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.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
Published scene.background.bgLayers.pattern.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.customPatternImage option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.gradient option.
- Type
GradientConfig- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.gradient.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.gradient.colors option.
- Type
{ stop: number; color: string; }[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.gradient.type option.
- Type
"linear" | "radial" | "conic"- Default
- Required
- Allowed
"linear""radial""conic"- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.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
Published scene.background.bgLayers.pattern.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.scale option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.secondaryColor option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.bgLayers.pattern.spacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.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
Published scene.background.bgLayers.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.blendMode
OptionalPublished scene.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
scene.background.blur
OptionalPublished scene.background.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.borderPosition
OptionalPublished scene.background.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.borderRadius
OptionalPublished scene.background.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.colorBg
OptionalPublished scene.background.colorBg option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.customBg
OptionalPublished scene.background.customBg option.
- Type
CanvasCustomBackground- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.customBg.align
OptionalPlacement used by `contain` / `cover` when `inherit` is false.
- Type
AlignMode- Default
- —
- Allowed
9 values
"center""top""bottom""left""right""top-left""top-right""bottom-left""bottom-right"- Runtime
- node22, node24, node26
Image filters applied to this background only.
- Type
ImageFilter[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.customBg.filters.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.customBg.filters.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.customBg.filters.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.customBg.filters.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.customBg.filters.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.customBg.filters.levels option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.customBg.filters.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.customBg.filters.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.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
Published scene.background.customBg.filters.value option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.customBg.filters.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Optional pixelate region. Omit for the whole filtered surface.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.customBg.filters.y option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.customBg.fit
OptionalResize policy when `inherit` is false.
- Type
FitMode- Default
- —
- Allowed
"fill""contain""cover"- Runtime
- node22, node24, node26
Adopt the source image dimensions as the canvas dimensions.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Background-image opacity, multiplied by the canvas-level opacity.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.customBg.source
RequiredPublished scene.background.customBg.source option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.gradientBg
OptionalPublished scene.background.gradientBg option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.gradientBg.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.gradientBg.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.gradientBg.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.gradientBg.endX
OptionalPublished scene.background.gradientBg.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.gradientBg.endY
OptionalPublished scene.background.gradientBg.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.gradientBg.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.gradientBg.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.gradientBg.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.background.gradientBg.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.gradientBg.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.gradientBg.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.gradientBg.type
RequiredPublished scene.background.gradientBg.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.background.gradientBg.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.gradientBg.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.gradientBg.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.gradientBg.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.gradientBg.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.noiseBg
OptionalPublished scene.background.noiseBg option.
- Type
{ intensity?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.noiseBg.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.opacity
OptionalPublished scene.background.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.patternBg
OptionalPublished scene.background.patternBg option.
- Type
PatternOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.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
scene.background.patternBg.color
OptionalPublished scene.background.patternBg.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.patternBg.customPatternImage option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.patternBg.gradient option.
- Type
GradientConfig- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.patternBg.gradient.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.patternBg.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.patternBg.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.patternBg.gradient.colors option.
- Type
{ stop: number; color: string; }[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.patternBg.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.patternBg.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.patternBg.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.patternBg.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.patternBg.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.patternBg.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.background.patternBg.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.patternBg.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.patternBg.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.patternBg.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.patternBg.gradient.type option.
- Type
"linear" | "radial" | "conic"- Default
- Required
- Allowed
"linear""radial""conic"- Runtime
- node22, node24, node26
Published scene.background.patternBg.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.patternBg.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.patternBg.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.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
Published scene.background.patternBg.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.patternBg.scale
OptionalPublished scene.background.patternBg.scale option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.patternBg.secondaryColor option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.patternBg.size
OptionalPublished scene.background.patternBg.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.patternBg.spacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.patternBg.type
RequiredPublished scene.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
scene.background.rotation
OptionalPublished scene.background.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.shadow
OptionalPublished scene.background.shadow option.
- Type
ShadowOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.shadow.blur
OptionalPublished scene.background.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.shadow.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.shadow.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.shadow.color
OptionalPublished scene.background.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.shadow.gradient
OptionalPublished scene.background.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.background.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.background.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.shadow.offsetX
OptionalPublished scene.background.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.shadow.offsetY
OptionalPublished scene.background.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.shadow.opacity
OptionalPublished scene.background.shadow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.shadow.roundedCorners option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.stroke
OptionalPublished scene.background.stroke option.
- Type
StrokeOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.stroke.blur
OptionalPublished scene.background.stroke.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.stroke.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.stroke.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.stroke.color
OptionalPublished scene.background.stroke.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.stroke.gradient
OptionalPublished scene.background.stroke.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.stroke.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.stroke.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.stroke.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.stroke.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.stroke.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.stroke.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.stroke.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.stroke.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.background.stroke.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.stroke.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.stroke.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.stroke.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.background.stroke.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.stroke.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.stroke.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.stroke.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.stroke.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.stroke.opacity
OptionalPublished scene.background.stroke.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.stroke.position
OptionalPublished scene.background.stroke.position option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.stroke.roundedCorners option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.stroke.style
OptionalPublished scene.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
scene.background.stroke.width
OptionalPublished scene.background.stroke.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.transparentBase
OptionalPublished scene.background.transparentBase option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
scene.background.videoBg
OptionalPublished scene.background.videoBg option.
- Type
CanvasVideoBackground- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.videoBg.align
OptionalPlacement used by `contain` / `cover` when `inherit` is false.
- Type
AlignMode- Default
- —
- Allowed
9 values
"center""top""bottom""left""right""top-left""top-right""bottom-left""bottom-right"- Runtime
- node22, node24, node26
Published scene.background.videoBg.autoplay option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
scene.background.videoBg.filters
OptionalImage filters applied to this background only.
- Type
ImageFilter[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.videoBg.filters.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.videoBg.filters.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.videoBg.filters.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.videoBg.filters.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.videoBg.filters.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.videoBg.filters.levels option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.videoBg.filters.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.videoBg.filters.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.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
Published scene.background.videoBg.filters.value option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.videoBg.filters.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Optional pixelate region. Omit for the whole filtered surface.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.background.videoBg.filters.y option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.videoBg.fit
OptionalResize policy when `inherit` is false.
- Type
FitMode- Default
- —
- Allowed
"fill""contain""cover"- Runtime
- node22, node24, node26
scene.background.videoBg.format
OptionalPublished scene.background.videoBg.format option.
- Type
"jpg" | "png"- Default
- —
- Allowed
"jpg""png"- Runtime
- node22, node24, node26
scene.background.videoBg.frame
Optional1-based frame number. Mutually exclusive with `time`. Defaults to frame 1 when neither selector is provided.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.videoBg.inherit
OptionalAdopt the source image dimensions as the canvas dimensions.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
scene.background.videoBg.loop
OptionalPublished scene.background.videoBg.loop option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
scene.background.videoBg.opacity
OptionalBackground-image opacity, multiplied by the canvas-level opacity.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.videoBg.quality
OptionalFFmpeg image quality value from 1 (best) through 31.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.videoBg.source
RequiredPublished scene.background.videoBg.source option.
- Type
string | Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.videoBg.time
OptionalTimestamp in seconds. Mutually exclusive with `frame`.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.x
OptionalPublished scene.background.x option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.y
OptionalPublished scene.background.y option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.zoom
OptionalPublished scene.background.zoom option.
- Type
{ scale?: number; centerX?: number; centerY?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.zoom.centerX
OptionalPublished scene.background.zoom.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.zoom.centerY
OptionalPublished scene.background.zoom.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.background.zoom.scale
OptionalPublished scene.background.zoom.scale option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.height
RequiredPublished scene.height option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers
RequiredPublished scene.layers option.
- Type
SceneLayer[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images
RequiredPublished scene.layers.images option.
- Type
ImageProperties | ImageProperties[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.align
OptionalPublished scene.layers.images.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
scene.layers.images.blendMode
OptionalPublished scene.layers.images.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
scene.layers.images.blur
OptionalPublished scene.layers.images.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.borderRadius
OptionalPublished scene.layers.images.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.boxBackground option.
- Type
BoxBackground- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.boxBackground.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.boxBackground.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.boxBackground.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.boxBackground.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.boxBackground.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.boxBackground.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.boxBackground.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.boxBackground.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.boxBackground.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.boxBackground.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.images.boxBackground.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.boxBackground.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.boxBackground.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.boxBackground.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.images.boxBackground.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.boxBackground.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.boxBackground.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.boxBackground.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.boxBackground.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.clipPath
OptionalPublished scene.layers.images.clipPath option.
- Type
{ x: number; y: number; }[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.clipPath.x
RequiredPublished scene.layers.images.clipPath.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.clipPath.y
RequiredPublished scene.layers.images.clipPath.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.distortion
OptionalPublished scene.layers.images.distortion option.
- Type
{ type: "perspective" | "warp" | "bulge" | "pinch"; points?: { x: number; y: number; }[]; intensity?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.distortion.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.distortion.points option.
- Type
{ x: number; y: number; }[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.distortion.points.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.distortion.points.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.distortion.type option.
- Type
"perspective" | "warp" | "bulge" | "pinch"- Default
- Required
- Allowed
"perspective""warp""bulge""pinch"- Runtime
- node22, node24, node26
scene.layers.images.effects
OptionalPublished scene.layers.images.effects option.
- Type
{ vignette?: { intensity: number; size: number; }; lensFlare?: { x: number; y: number; intensity: number; }; chromaticAberration?: { intensity: number; }; filmGrain?: { intensity: number; }; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.effects.chromaticAberration option.
- Type
{ intensity: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.effects.chromaticAberration.intensity option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.effects.filmGrain option.
- Type
{ intensity: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.effects.filmGrain.intensity option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.effects.lensFlare option.
- Type
{ x: number; y: number; intensity: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.effects.lensFlare.intensity option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.effects.lensFlare.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.effects.lensFlare.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.effects.vignette option.
- Type
{ intensity: number; size: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.effects.vignette.intensity option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.effects.vignette.size option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.filterIntensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.filterOrder
OptionalPublished scene.layers.images.filterOrder option.
- Type
"pre" | "post"- Default
- —
- Allowed
"pre""post"- Runtime
- node22, node24, node26
scene.layers.images.filters
OptionalPublished scene.layers.images.filters option.
- Type
ImageFilter[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.filters.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.filters.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.filters.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.filters.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.filters.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.filters.levels option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.filters.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.filters.size
OptionalPublished scene.layers.images.filters.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.filters.type
RequiredPublished scene.layers.images.filters.type option.
- Type
"saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize"- Default
- Required
- Allowed
17 values
"saturation""gaussianBlur""motionBlur""radialBlur""sharpen""noise""grain""edgeDetection""emboss""invert""grayscale""sepia""pixelate""brightness""contrast""hueShift""posterize"- Runtime
- node22, node24, node26
Published scene.layers.images.filters.value option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.filters.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.filters.x
OptionalOptional pixelate region. Omit for the whole filtered surface.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.filters.y
OptionalPublished scene.layers.images.filters.y option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.fit
OptionalPublished scene.layers.images.fit option.
- Type
FitMode- Default
- —
- Allowed
"fill""contain""cover"- Runtime
- node22, node24, node26
scene.layers.images.height
OptionalPublished scene.layers.images.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.inherit
OptionalPublished scene.layers.images.inherit option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
scene.layers.images.mask
OptionalPublished scene.layers.images.mask option.
- Type
{ source: string | Buffer<ArrayBufferLike>; mode?: "alpha" | "luminance" | "inverse"; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.mask.mode
OptionalPublished scene.layers.images.mask.mode option.
- Type
"alpha" | "luminance" | "inverse"- Default
- —
- Allowed
"alpha""luminance""inverse"- Runtime
- node22, node24, node26
scene.layers.images.mask.source
RequiredPublished scene.layers.images.mask.source option.
- Type
string | Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.meshWarp
OptionalPublished scene.layers.images.meshWarp option.
- Type
{ gridX?: number; gridY?: number; controlPoints?: { x: number; y: number; }[][]; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.meshWarp.controlPoints option.
- Type
{ x: number; y: number; }[][]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.meshWarp.controlPoints.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.meshWarp.controlPoints.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.meshWarp.gridX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.meshWarp.gridY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.opacity
OptionalPublished scene.layers.images.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.rotation
OptionalPublished scene.layers.images.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.shadow
OptionalPublished scene.layers.images.shadow option.
- Type
ShadowOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.shadow.blur
OptionalPublished scene.layers.images.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.shadow.color
OptionalPublished scene.layers.images.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shadow.roundedCorners option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.shape
OptionalPublished scene.layers.images.shape option.
- Type
ShapeProperties- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.shape.color
OptionalPublished scene.layers.images.shape.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.endAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.shape.fill
OptionalPublished scene.layers.images.shape.fill option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published scene.layers.images.shape.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.images.shape.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.images.shape.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.innerRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.outerRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.shape.points
OptionalPublished scene.layers.images.shape.points option.
- Type
{ x: number; y: number; }[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.points.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.points.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.shape.radius
OptionalPublished scene.layers.images.shape.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.shape.sides
OptionalPublished scene.layers.images.shape.sides option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.shape.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.source
RequiredPublished scene.layers.images.source option.
- Type
string | Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.stroke
OptionalPublished scene.layers.images.stroke option.
- Type
StrokeOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.stroke.blur
OptionalPublished scene.layers.images.stroke.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.stroke.color
OptionalPublished scene.layers.images.stroke.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.position option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.images.stroke.roundedCorners option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.stroke.style
OptionalPublished scene.layers.images.stroke.style option.
- Type
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"- Default
- —
- Allowed
6 values
"solid""dashed""dotted""groove""ridge""double"- Runtime
- node22, node24, node26
scene.layers.images.stroke.width
OptionalPublished scene.layers.images.stroke.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.width
OptionalPublished scene.layers.images.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.x
RequiredPublished scene.layers.images.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.images.y
RequiredPublished scene.layers.images.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.options
OptionalPublished scene.layers.options option.
- Type
CreateImageOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform option.
- Type
GroupTransformOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.blendMode option.
- Type
GlobalCompositeOperation- Default
- —
- Allowed
26 values
"color""color-burn""color-dodge""copy""darken""destination-atop""destination-in""destination-out""destination-over""difference""exclusion""hard-light""hue""lighten""lighter""luminosity""multiply""overlay""saturation""screen""soft-light""source-atop""source-in""source-out""source-over""xor"- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.boxBackground option.
- Type
BoxBackground- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.boxBackground.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.boxBackground.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.boxBackground.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.boxBackground.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.boxBackground.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.boxBackground.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.boxBackground.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.boxBackground.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.boxBackground.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.boxBackground.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.boxBackground.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.boxBackground.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.boxBackground.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.boxBackground.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.boxBackground.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.boxBackground.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.boxBackground.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.boxBackground.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.boxBackground.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.clipPath option.
- Type
{ x: number; y: number; }[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.clipPath.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.clipPath.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.distortion option.
- Type
{ type: "perspective" | "warp" | "bulge" | "pinch"; points?: { x: number; y: number; }[]; intensity?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.distortion.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.distortion.points option.
- Type
{ x: number; y: number; }[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.distortion.points.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.distortion.points.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.distortion.type option.
- Type
"perspective" | "warp" | "bulge" | "pinch"- Default
- Required
- Allowed
"perspective""warp""bulge""pinch"- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.effects option.
- Type
{ vignette?: { intensity: number; size: number; }; lensFlare?: { x: number; y: number; intensity: number; }; chromaticAberration?: { intensity: number; }; filmGrain?: { intensity: number; }; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.effects.chromaticAberration option.
- Type
{ intensity: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.effects.chromaticAberration.intensity option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.effects.filmGrain option.
- Type
{ intensity: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.effects.filmGrain.intensity option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.effects.lensFlare option.
- Type
{ x: number; y: number; intensity: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.effects.lensFlare.intensity option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.effects.lensFlare.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.effects.lensFlare.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.effects.vignette option.
- Type
{ intensity: number; size: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.effects.vignette.intensity option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.effects.vignette.size option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.filterIntensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.filterOrder option.
- Type
"pre" | "post"- Default
- —
- Allowed
"pre""post"- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.filters option.
- Type
ImageFilter[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.filters.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.filters.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.filters.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.filters.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.filters.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.filters.levels option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.filters.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.filters.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.filters.type option.
- Type
"saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize"- Default
- Required
- Allowed
17 values
"saturation""gaussianBlur""motionBlur""radialBlur""sharpen""noise""grain""edgeDetection""emboss""invert""grayscale""sepia""pixelate""brightness""contrast""hueShift""posterize"- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.filters.value option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.filters.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Optional pixelate region. Omit for the whole filtered surface.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.filters.y option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.mask option.
- Type
{ source: string | Buffer<ArrayBufferLike>; mode?: "alpha" | "luminance" | "inverse"; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.mask.mode option.
- Type
"alpha" | "luminance" | "inverse"- Default
- —
- Allowed
"alpha""luminance""inverse"- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.mask.source option.
- Type
string | Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.meshWarp option.
- Type
{ gridX?: number; gridY?: number; controlPoints?: { x: number; y: number; }[][]; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.meshWarp.controlPoints option.
- Type
{ x: number; y: number; }[][]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.meshWarp.controlPoints.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.meshWarp.controlPoints.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.meshWarp.gridX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.meshWarp.gridY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.scaleX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.scaleY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow option.
- Type
ShadowOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.shadow.roundedCorners option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke option.
- Type
StrokeOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.position option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.roundedCorners option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.style option.
- Type
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"- Default
- —
- Allowed
6 values
"solid""dashed""dotted""groove""ridge""double"- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.stroke.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.translateX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.options.groupTransform.translateY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.options.isGrouped
OptionalPublished scene.layers.options.isGrouped option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
scene.layers.type
RequiredPublished scene.layers.type option.
- Type
"image"- Default
- Required
- Allowed
"image"- Runtime
- node22, node24, node26
scene.layers.texts
RequiredPublished scene.layers.texts option.
- Type
TextProperties | TextProperties[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.bold
OptionalPublished scene.layers.texts.bold option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
scene.layers.texts.color
OptionalPublished scene.layers.texts.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.decorations
OptionalGrouped line decorations (`underline` / `overline` / `strikethrough`) and optional `bold` / `italic` flags for the canvas font string. Nested keys override the legacy flat fields (see {@link resolveTextDecorations}).
- Type
TextDecorations- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.bold option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.italic option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.overline.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.strikethrough.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.decorations.underline.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.effects
OptionalGrouped highlight, glow, and shadow. When set, entries override the legacy flat fields (see {@link resolveTextEffects}).
- Type
TextEffects- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.effects.glow
OptionalPublished scene.layers.texts.effects.glow option.
- Type
TextGlowStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.glow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight option.
- Type
TextHighlightStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.highlight.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow option.
- Type
TextShadowStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.effects.shadow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.fill
OptionalGrouped fill color / gradient and draw opacity (see {@link resolveTextFill}).
- Type
TextFill- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.fill.color
OptionalPublished scene.layers.texts.fill.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.fill.gradient
OptionalPublished scene.layers.texts.fill.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.fill.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.fill.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.fill.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.fill.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.fill.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.fill.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.fill.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.fill.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.texts.fill.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.fill.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.fill.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.fill.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.texts.fill.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.fill.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.fill.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.fill.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.fill.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.fill.opacity
OptionalPublished scene.layers.texts.fill.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.font
OptionalPublished scene.layers.texts.font option.
- Type
{ size?: number; family?: string; name?: string; path?: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.font.family
OptionalPublished scene.layers.texts.font.family option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.font.name
OptionalPublished scene.layers.texts.font.name option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.font.path
OptionalPublished scene.layers.texts.font.path option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.font.size
OptionalPublished scene.layers.texts.font.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.fontFamily
OptionalPublished scene.layers.texts.fontFamily option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.fontName
OptionalPublished scene.layers.texts.fontName option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.fontPath
OptionalPublished scene.layers.texts.fontPath option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.fontSize
OptionalPublished scene.layers.texts.fontSize option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.glow
OptionalPublished scene.layers.texts.glow option.
- Type
TextGlowStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.glow.color
OptionalPublished scene.layers.texts.glow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.glow.gradient
OptionalPublished scene.layers.texts.glow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.glow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.glow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.glow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.glow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.glow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.glow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.glow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.glow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.texts.glow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.glow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.glow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.glow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.texts.glow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.glow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.glow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.glow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.glow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.glow.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.glow.opacity
OptionalPublished scene.layers.texts.glow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.gradient
OptionalPublished scene.layers.texts.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.gradient.endX
OptionalPublished scene.layers.texts.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.gradient.endY
OptionalPublished scene.layers.texts.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.texts.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.gradient.type
RequiredPublished scene.layers.texts.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.texts.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.highlight
OptionalPublished scene.layers.texts.highlight option.
- Type
TextHighlightStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.highlight.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.highlight.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.highlight.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.highlight.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.highlight.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.highlight.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.highlight.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.highlight.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.highlight.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.highlight.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.texts.highlight.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.highlight.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.highlight.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.highlight.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.texts.highlight.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.highlight.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.highlight.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.highlight.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.highlight.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.highlight.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.includeCharMetrics option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
scene.layers.texts.italic
OptionalPublished scene.layers.texts.italic option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
scene.layers.texts.layout
OptionalGrouped line height, spacing, and wrap bounds (see {@link resolveTextLayout}).
- Type
TextLayout- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.layout.letterSpacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.layout.lineHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.layout.maxHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.layout.maxWidth option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.layout.wordSpacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.letterSpacing
OptionalPublished scene.layers.texts.letterSpacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.lineHeight
OptionalPublished scene.layers.texts.lineHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.maxHeight
OptionalPublished scene.layers.texts.maxHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.maxWidth
OptionalPublished scene.layers.texts.maxWidth option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.measurementCanvas option.
- Type
{ width?: number; height?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.measurementCanvas.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.measurementCanvas.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.opacity
OptionalPublished scene.layers.texts.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.overline
OptionalPublished scene.layers.texts.overline option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.overline.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.overline.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.overline.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.overline.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.overline.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.overline.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.overline.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.overline.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.overline.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.overline.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.texts.overline.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.overline.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.overline.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.overline.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.texts.overline.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.overline.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.overline.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.overline.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.overline.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.overline.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.placement
OptionalGrouped alignment, baseline, and rotation (see {@link resolveTextPlacement}).
- Type
TextPlacement- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.placement.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.placement.textAlign option.
- Type
TextAlignMode- Default
- —
- Allowed
5 values
"center""left""right""start""end"- Runtime
- node22, node24, node26
Published scene.layers.texts.placement.textBaseline option.
- Type
TextBaselineMode- Default
- —
- Allowed
6 values
"top""bottom""alphabetic""hanging""ideographic""middle"- Runtime
- node22, node24, node26
scene.layers.texts.rotation
OptionalPublished scene.layers.texts.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.shadow
OptionalPublished scene.layers.texts.shadow option.
- Type
TextShadowStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.shadow.blur
OptionalPublished scene.layers.texts.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.shadow.color
OptionalPublished scene.layers.texts.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.shadow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.strikethrough
OptionalPublished scene.layers.texts.strikethrough option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.strikethrough.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.strikethrough.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.strikethrough.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.strikethrough.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.strikethrough.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.strikethrough.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.strikethrough.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.strikethrough.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.strikethrough.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.strikethrough.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.texts.strikethrough.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.strikethrough.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.strikethrough.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.strikethrough.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.texts.strikethrough.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.strikethrough.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.strikethrough.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.strikethrough.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.strikethrough.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.strikethrough.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.stroke
OptionalPublished scene.layers.texts.stroke option.
- Type
TextStrokeStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.stroke.color
OptionalPublished scene.layers.texts.stroke.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.stroke.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.stroke.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.stroke.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.stroke.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.stroke.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.stroke.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.stroke.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.stroke.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.stroke.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.texts.stroke.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.stroke.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.stroke.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.stroke.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.texts.stroke.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.stroke.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.stroke.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.stroke.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.stroke.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.stroke.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.stroke.style
OptionalPublished scene.layers.texts.stroke.style option.
- Type
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"- Default
- —
- Allowed
6 values
"solid""dashed""dotted""groove""ridge""double"- Runtime
- node22, node24, node26
scene.layers.texts.stroke.width
OptionalPublished scene.layers.texts.stroke.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.text
RequiredPublished scene.layers.texts.text option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.textAlign
OptionalPublished scene.layers.texts.textAlign option.
- Type
TextAlignMode- Default
- —
- Allowed
5 values
"center""left""right""start""end"- Runtime
- node22, node24, node26
scene.layers.texts.textBaseline
OptionalPublished scene.layers.texts.textBaseline option.
- Type
TextBaselineMode- Default
- —
- Allowed
6 values
"top""bottom""alphabetic""hanging""ideographic""middle"- Runtime
- node22, node24, node26
scene.layers.texts.textOnCurve
OptionalPublished scene.layers.texts.textOnCurve option.
- Type
TextCurveConfig- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.textOnCurve.baselineOffset option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.textOnCurve.layoutMode option.
- Type
CurvedTextLayoutMode- Default
- —
- Allowed
"fit""clamp""override"- Runtime
- node22, node24, node26
Published scene.layers.texts.textOnCurve.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.textOnCurve.startAngleDeg option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.textOnCurve.sweepAngle option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.textOnCurve.up option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
scene.layers.texts.underline
OptionalPublished scene.layers.texts.underline option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.underline.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.underline.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.underline.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.underline.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.underline.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.underline.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.underline.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.underline.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.underline.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.underline.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.texts.underline.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.underline.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.underline.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.underline.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.texts.underline.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.underline.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.underline.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.underline.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.underline.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.texts.underline.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.wordSpacing
OptionalPublished scene.layers.texts.wordSpacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.x
RequiredPublished scene.layers.texts.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.texts.y
RequiredPublished scene.layers.texts.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.path
RequiredPublished scene.layers.path option.
- Type
unknown- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.buffer
RequiredPublished scene.layers.buffer option.
- Type
Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.globalAlpha
OptionalPublished scene.layers.globalAlpha option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.globalCompositeOperation 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
scene.layers.height
OptionalPublished scene.layers.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.width
OptionalPublished scene.layers.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.x
RequiredPublished scene.layers.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.y
RequiredPublished scene.layers.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.chartType
RequiredPublished scene.layers.chartType option.
- Type
SceneChartType- Default
- Required
- Allowed
7 values
"pie""bar""horizontalBar""line""scatter""radar""polarArea"- Runtime
- node22, node24, node26
scene.layers.data
RequiredPublished scene.layers.data option.
- Type
unknown- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.opacity
OptionalPublished scene.layers.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.lines
RequiredPublished scene.layers.lines option.
- Type
CustomOptions | CustomOptions[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.lines.arrow
OptionalPublished scene.layers.lines.arrow option.
- Type
{ start?: boolean; end?: boolean; size?: number; style?: "filled" | "outline"; color?: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.lines.arrow.color
OptionalPublished scene.layers.lines.arrow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.lines.arrow.end
OptionalPublished scene.layers.lines.arrow.end option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
scene.layers.lines.arrow.size
OptionalPublished scene.layers.lines.arrow.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.lines.arrow.start
OptionalPublished scene.layers.lines.arrow.start option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
scene.layers.lines.arrow.style
OptionalPublished scene.layers.lines.arrow.style option.
- Type
"filled" | "outline"- Default
- —
- Allowed
"filled""outline"- Runtime
- node22, node24, node26
Published scene.layers.lines.endCoordinates option.
- Type
{ x: number; y: number; }- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.endCoordinates.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.endCoordinates.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.lines.lineStyle
OptionalPublished scene.layers.lines.lineStyle option.
- Type
{ width?: number; color?: string; gradient?: gradient; lineRadius?: string | number; lineJoin?: "round" | "bevel" | "miter"; lineCap?: "square" | "butt" | "round"; singleLine?: boolean; lineDash?: { dashArray?: number[]; offset?: number; }; pattern?: { type: "dots" | "custom" | "dashes"; segments?: number[]; offset?: number; }; texture?: string | Buffer<ArrayBufferLike>; stroke?: { color?: string; gradient?: gradient; width?: number; lineRadius?: string | number; lineCap?: "square" | "butt" | "round"; }; shadow?: { offsetX?: number; offsetY?: number; blur?: number; color?: string; gradient?: gradient; lineRadius?: string | number; }; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.lineCap option.
- Type
"square" | "butt" | "round"- Default
- —
- Allowed
"square""butt""round"- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.lineDash option.
- Type
{ dashArray?: number[]; offset?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.lineDash.dashArray option.
- Type
number[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.lineDash.offset option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.lineJoin option.
- Type
"round" | "bevel" | "miter"- Default
- —
- Allowed
"round""bevel""miter"- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.lineRadius option.
- Type
string | number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.pattern option.
- Type
{ type: "dots" | "custom" | "dashes"; segments?: number[]; offset?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.pattern.offset option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.pattern.segments option.
- Type
number[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.pattern.type option.
- Type
"dots" | "custom" | "dashes"- Default
- Required
- Allowed
"dots""custom""dashes"- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow option.
- Type
{ offsetX?: number; offsetY?: number; blur?: number; color?: string; gradient?: gradient; lineRadius?: string | number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.lineRadius option.
- Type
string | number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.singleLine option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke option.
- Type
{ color?: string; gradient?: gradient; width?: number; lineRadius?: string | number; lineCap?: "square" | "butt" | "round"; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.lineCap option.
- Type
"square" | "butt" | "round"- Default
- —
- Allowed
"square""butt""round"- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.lineRadius option.
- Type
string | number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.stroke.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.texture option.
- Type
string | Buffer<ArrayBufferLike>- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.lineStyle.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.lines.markers
OptionalPublished scene.layers.lines.markers option.
- Type
{ position: number; shape: "square" | "circle" | "diamond" | "arrow"; size: number; color: string; }[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.lines.markers.color
RequiredPublished scene.layers.lines.markers.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.markers.position option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.lines.markers.shape
RequiredPublished scene.layers.lines.markers.shape option.
- Type
"square" | "circle" | "diamond" | "arrow"- Default
- Required
- Allowed
"square""circle""diamond""arrow"- Runtime
- node22, node24, node26
scene.layers.lines.markers.size
RequiredPublished scene.layers.lines.markers.size option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.lines.path
OptionalPublished scene.layers.lines.path option.
- Type
{ type: "bezier" | "smooth" | "catmull-rom"; tension?: number; closed?: boolean; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.lines.path.closed
OptionalPublished scene.layers.lines.path.closed option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
scene.layers.lines.path.tension
OptionalPublished scene.layers.lines.path.tension option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.lines.path.type
RequiredPublished scene.layers.lines.path.type option.
- Type
"bezier" | "smooth" | "catmull-rom"- Default
- Required
- Allowed
"bezier""smooth""catmull-rom"- Runtime
- node22, node24, node26
Published scene.layers.lines.startCoordinates option.
- Type
{ x: number; y: number; }- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.startCoordinates.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.lines.startCoordinates.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.background
OptionalChild background paint only; dimensions are always taken from `placement`.
- Type
SceneBackground- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.background.bgLayers
OptionalPublished scene.layers.background.bgLayers option.
- Type
BackgroundLayer[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.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
Published scene.layers.background.bgLayers.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.type option.
- Type
"color"- Default
- Required
- Allowed
"color"- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.value option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.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
Published scene.layers.background.bgLayers.fit option.
- Type
"fill" | "contain" | "cover"- Default
- —
- Allowed
"fill""contain""cover"- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.source option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.repeat option.
- Type
BackgroundPatternRepeat- Default
- —
- Allowed
"repeat""no-repeat""repeat-x""repeat-y"- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern option.
- Type
PatternOptions- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.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
Published scene.layers.background.bgLayers.pattern.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.customPatternImage option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.gradient option.
- Type
GradientConfig- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.gradient.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.gradient.colors option.
- Type
{ stop: number; color: string; }[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.gradient.type option.
- Type
"linear" | "radial" | "conic"- Default
- Required
- Allowed
"linear""radial""conic"- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.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
Published scene.layers.background.bgLayers.pattern.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.scale option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.secondaryColor option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.bgLayers.pattern.spacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.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
Published scene.layers.background.bgLayers.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.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
scene.layers.background.blur
OptionalPublished scene.layers.background.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.background.colorBg
OptionalPublished scene.layers.background.colorBg option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.background.customBg
OptionalPublished scene.layers.background.customBg option.
- Type
CanvasCustomBackground- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Placement used by `contain` / `cover` when `inherit` is false.
- Type
AlignMode- Default
- —
- Allowed
9 values
"center""top""bottom""left""right""top-left""top-right""bottom-left""bottom-right"- Runtime
- node22, node24, node26
Image filters applied to this background only.
- Type
ImageFilter[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.customBg.filters.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.customBg.filters.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.customBg.filters.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.customBg.filters.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.customBg.filters.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.customBg.filters.levels option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.customBg.filters.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.customBg.filters.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.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
Published scene.layers.background.customBg.filters.value option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.customBg.filters.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Optional pixelate region. Omit for the whole filtered surface.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.customBg.filters.y option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Resize policy when `inherit` is false.
- Type
FitMode- Default
- —
- Allowed
"fill""contain""cover"- Runtime
- node22, node24, node26
Adopt the source image dimensions as the canvas dimensions.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Background-image opacity, multiplied by the canvas-level opacity.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.customBg.source option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.gradientBg option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.gradientBg.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.gradientBg.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.gradientBg.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.gradientBg.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.gradientBg.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.gradientBg.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.gradientBg.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.gradientBg.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.background.gradientBg.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.gradientBg.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.gradientBg.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.gradientBg.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.background.gradientBg.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.gradientBg.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.gradientBg.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.gradientBg.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.gradientBg.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.background.noiseBg
OptionalPublished scene.layers.background.noiseBg option.
- Type
{ intensity?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.noiseBg.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.background.opacity
OptionalPublished scene.layers.background.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg option.
- Type
PatternOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.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
Published scene.layers.background.patternBg.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.customPatternImage option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.gradient option.
- Type
GradientConfig- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.gradient.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.gradient.colors option.
- Type
{ stop: number; color: string; }[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.gradient.type option.
- Type
"linear" | "radial" | "conic"- Default
- Required
- Allowed
"linear""radial""conic"- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.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
Published scene.layers.background.patternBg.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.scale option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.secondaryColor option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.patternBg.spacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.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
scene.layers.background.rotation
OptionalPublished scene.layers.background.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.background.shadow
OptionalPublished scene.layers.background.shadow option.
- Type
ShadowOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.shadow.roundedCorners option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.background.stroke
OptionalPublished scene.layers.background.stroke option.
- Type
StrokeOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.position option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.stroke.roundedCorners option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.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
Published scene.layers.background.stroke.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.transparentBase option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
scene.layers.background.videoBg
OptionalPublished scene.layers.background.videoBg option.
- Type
CanvasVideoBackground- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Placement used by `contain` / `cover` when `inherit` is false.
- Type
AlignMode- Default
- —
- Allowed
9 values
"center""top""bottom""left""right""top-left""top-right""bottom-left""bottom-right"- Runtime
- node22, node24, node26
Published scene.layers.background.videoBg.autoplay option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Image filters applied to this background only.
- Type
ImageFilter[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.videoBg.filters.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.videoBg.filters.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.videoBg.filters.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.videoBg.filters.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.videoBg.filters.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.videoBg.filters.levels option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.videoBg.filters.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.videoBg.filters.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.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
Published scene.layers.background.videoBg.filters.value option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.videoBg.filters.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Optional pixelate region. Omit for the whole filtered surface.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.videoBg.filters.y option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Resize policy when `inherit` is false.
- Type
FitMode- Default
- —
- Allowed
"fill""contain""cover"- Runtime
- node22, node24, node26
Published scene.layers.background.videoBg.format option.
- Type
"jpg" | "png"- Default
- —
- Allowed
"jpg""png"- Runtime
- node22, node24, node26
1-based frame number. Mutually exclusive with `time`. Defaults to frame 1 when neither selector is provided.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Adopt the source image dimensions as the canvas dimensions.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published scene.layers.background.videoBg.loop option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Background-image opacity, multiplied by the canvas-level opacity.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
FFmpeg image quality value from 1 (best) through 31.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.videoBg.source option.
- Type
string | Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Timestamp in seconds. Mutually exclusive with `frame`.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.background.x
OptionalPublished scene.layers.background.x option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.background.y
OptionalPublished scene.layers.background.y option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.background.zoom
OptionalPublished scene.layers.background.zoom option.
- Type
{ scale?: number; centerX?: number; centerY?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.zoom.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.zoom.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.background.zoom.scale option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers
RequiredChild layers are clipped to the child surface canvas before parent transforms/opacity are applied.
- Type
SceneLayer[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.images
RequiredPublished scene.layers.layers.images option.
- Type
ImageProperties | ImageProperties[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.images.align
OptionalPublished scene.layers.layers.images.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
Published scene.layers.layers.images.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
scene.layers.layers.images.blur
OptionalPublished scene.layers.layers.images.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.boxBackground option.
- Type
BoxBackground- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.boxBackground.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.boxBackground.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.boxBackground.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.boxBackground.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.boxBackground.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.boxBackground.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.boxBackground.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.boxBackground.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.boxBackground.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.boxBackground.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.images.boxBackground.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.boxBackground.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.boxBackground.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.boxBackground.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.images.boxBackground.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.boxBackground.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.boxBackground.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.boxBackground.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.boxBackground.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.clipPath option.
- Type
{ x: number; y: number; }[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.clipPath.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.clipPath.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.distortion option.
- Type
{ type: "perspective" | "warp" | "bulge" | "pinch"; points?: { x: number; y: number; }[]; intensity?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.distortion.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.distortion.points option.
- Type
{ x: number; y: number; }[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.distortion.points.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.distortion.points.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.distortion.type option.
- Type
"perspective" | "warp" | "bulge" | "pinch"- Default
- Required
- Allowed
"perspective""warp""bulge""pinch"- Runtime
- node22, node24, node26
Published scene.layers.layers.images.effects option.
- Type
{ vignette?: { intensity: number; size: number; }; lensFlare?: { x: number; y: number; intensity: number; }; chromaticAberration?: { intensity: number; }; filmGrain?: { intensity: number; }; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.effects.chromaticAberration option.
- Type
{ intensity: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.effects.chromaticAberration.intensity option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.effects.filmGrain option.
- Type
{ intensity: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.effects.filmGrain.intensity option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.effects.lensFlare option.
- Type
{ x: number; y: number; intensity: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.effects.lensFlare.intensity option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.effects.lensFlare.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.effects.lensFlare.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.effects.vignette option.
- Type
{ intensity: number; size: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.effects.vignette.intensity option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.effects.vignette.size option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.filterIntensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.filterOrder option.
- Type
"pre" | "post"- Default
- —
- Allowed
"pre""post"- Runtime
- node22, node24, node26
Published scene.layers.layers.images.filters option.
- Type
ImageFilter[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.filters.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.filters.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.filters.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.filters.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.filters.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.filters.levels option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.filters.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.filters.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.filters.type option.
- Type
"saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize"- Default
- Required
- Allowed
17 values
"saturation""gaussianBlur""motionBlur""radialBlur""sharpen""noise""grain""edgeDetection""emboss""invert""grayscale""sepia""pixelate""brightness""contrast""hueShift""posterize"- Runtime
- node22, node24, node26
Published scene.layers.layers.images.filters.value option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.filters.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Optional pixelate region. Omit for the whole filtered surface.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.filters.y option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.images.fit
OptionalPublished scene.layers.layers.images.fit option.
- Type
FitMode- Default
- —
- Allowed
"fill""contain""cover"- Runtime
- node22, node24, node26
Published scene.layers.layers.images.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.inherit option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
scene.layers.layers.images.mask
OptionalPublished scene.layers.layers.images.mask option.
- Type
{ source: string | Buffer<ArrayBufferLike>; mode?: "alpha" | "luminance" | "inverse"; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.mask.mode option.
- Type
"alpha" | "luminance" | "inverse"- Default
- —
- Allowed
"alpha""luminance""inverse"- Runtime
- node22, node24, node26
Published scene.layers.layers.images.mask.source option.
- Type
string | Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.meshWarp option.
- Type
{ gridX?: number; gridY?: number; controlPoints?: { x: number; y: number; }[][]; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.meshWarp.controlPoints option.
- Type
{ x: number; y: number; }[][]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.meshWarp.controlPoints.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.meshWarp.controlPoints.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.meshWarp.gridX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.meshWarp.gridY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow option.
- Type
ShadowOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shadow.roundedCorners option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.images.shape
OptionalPublished scene.layers.layers.images.shape option.
- Type
ShapeProperties- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.endAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.fill option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.innerRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.outerRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.points option.
- Type
{ x: number; y: number; }[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.points.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.points.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.sides option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.shape.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.source option.
- Type
string | Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke option.
- Type
StrokeOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.position option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.roundedCorners option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.style option.
- Type
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"- Default
- —
- Allowed
6 values
"solid""dashed""dotted""groove""ridge""double"- Runtime
- node22, node24, node26
Published scene.layers.layers.images.stroke.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.images.width
OptionalPublished scene.layers.layers.images.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.images.x
RequiredPublished scene.layers.layers.images.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.images.y
RequiredPublished scene.layers.layers.images.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.options
OptionalPublished scene.layers.layers.options option.
- Type
CreateImageOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform option.
- Type
GroupTransformOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.blendMode option.
- Type
GlobalCompositeOperation- Default
- —
- Allowed
26 values
"color""color-burn""color-dodge""copy""darken""destination-atop""destination-in""destination-out""destination-over""difference""exclusion""hard-light""hue""lighten""lighter""luminosity""multiply""overlay""saturation""screen""soft-light""source-atop""source-in""source-out""source-over""xor"- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.boxBackground option.
- Type
BoxBackground- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.boxBackground.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.boxBackground.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.boxBackground.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.boxBackground.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.boxBackground.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.boxBackground.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.boxBackground.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.boxBackground.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.boxBackground.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.boxBackground.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.boxBackground.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.boxBackground.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.boxBackground.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.boxBackground.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.boxBackground.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.boxBackground.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.boxBackground.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.boxBackground.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.boxBackground.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.clipPath option.
- Type
{ x: number; y: number; }[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.clipPath.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.clipPath.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.distortion option.
- Type
{ type: "perspective" | "warp" | "bulge" | "pinch"; points?: { x: number; y: number; }[]; intensity?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.distortion.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.distortion.points option.
- Type
{ x: number; y: number; }[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.distortion.points.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.distortion.points.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.distortion.type option.
- Type
"perspective" | "warp" | "bulge" | "pinch"- Default
- Required
- Allowed
"perspective""warp""bulge""pinch"- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.effects option.
- Type
{ vignette?: { intensity: number; size: number; }; lensFlare?: { x: number; y: number; intensity: number; }; chromaticAberration?: { intensity: number; }; filmGrain?: { intensity: number; }; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.effects.chromaticAberration option.
- Type
{ intensity: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.effects.chromaticAberration.intensity option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.effects.filmGrain option.
- Type
{ intensity: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.effects.filmGrain.intensity option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.effects.lensFlare option.
- Type
{ x: number; y: number; intensity: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.effects.lensFlare.intensity option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.effects.lensFlare.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.effects.lensFlare.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.effects.vignette option.
- Type
{ intensity: number; size: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.effects.vignette.intensity option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.effects.vignette.size option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.filterIntensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.filterOrder option.
- Type
"pre" | "post"- Default
- —
- Allowed
"pre""post"- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.filters option.
- Type
ImageFilter[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.filters.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.filters.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.filters.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.filters.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.filters.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.filters.levels option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.filters.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.filters.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.filters.type option.
- Type
"saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize"- Default
- Required
- Allowed
17 values
"saturation""gaussianBlur""motionBlur""radialBlur""sharpen""noise""grain""edgeDetection""emboss""invert""grayscale""sepia""pixelate""brightness""contrast""hueShift""posterize"- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.filters.value option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.filters.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Optional pixelate region. Omit for the whole filtered surface.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.filters.y option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.mask option.
- Type
{ source: string | Buffer<ArrayBufferLike>; mode?: "alpha" | "luminance" | "inverse"; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.mask.mode option.
- Type
"alpha" | "luminance" | "inverse"- Default
- —
- Allowed
"alpha""luminance""inverse"- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.mask.source option.
- Type
string | Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.meshWarp option.
- Type
{ gridX?: number; gridY?: number; controlPoints?: { x: number; y: number; }[][]; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.meshWarp.controlPoints option.
- Type
{ x: number; y: number; }[][]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.meshWarp.controlPoints.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.meshWarp.controlPoints.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.meshWarp.gridX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.meshWarp.gridY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.scaleX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.scaleY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow option.
- Type
ShadowOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.shadow.roundedCorners option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke option.
- Type
StrokeOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.position option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.roundedCorners option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.style option.
- Type
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"- Default
- —
- Allowed
6 values
"solid""dashed""dotted""groove""ridge""double"- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.stroke.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.translateX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.groupTransform.translateY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.options.isGrouped option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
scene.layers.layers.type
RequiredPublished scene.layers.layers.type option.
- Type
"image"- Default
- Required
- Allowed
"image"- Runtime
- node22, node24, node26
scene.layers.layers.texts
RequiredPublished scene.layers.layers.texts option.
- Type
TextProperties | TextProperties[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.texts.bold
OptionalPublished scene.layers.layers.texts.bold option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
scene.layers.layers.texts.color
OptionalPublished scene.layers.layers.texts.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Grouped line decorations (`underline` / `overline` / `strikethrough`) and optional `bold` / `italic` flags for the canvas font string. Nested keys override the legacy flat fields (see {@link resolveTextDecorations}).
- Type
TextDecorations- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.bold option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.italic option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.overline.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.strikethrough.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.decorations.underline.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Grouped highlight, glow, and shadow. When set, entries override the legacy flat fields (see {@link resolveTextEffects}).
- Type
TextEffects- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow option.
- Type
TextGlowStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.glow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight option.
- Type
TextHighlightStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.highlight.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow option.
- Type
TextShadowStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.effects.shadow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.texts.fill
OptionalGrouped fill color / gradient and draw opacity (see {@link resolveTextFill}).
- Type
TextFill- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fill.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fill.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fill.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fill.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fill.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fill.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fill.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fill.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fill.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fill.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fill.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fill.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fill.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fill.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fill.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fill.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fill.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fill.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fill.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fill.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.texts.font
OptionalPublished scene.layers.layers.texts.font option.
- Type
{ size?: number; family?: string; name?: string; path?: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.font.family option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.font.name option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.font.path option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.font.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fontFamily option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fontName option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fontPath option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.fontSize option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.texts.glow
OptionalPublished scene.layers.layers.texts.glow option.
- Type
TextGlowStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.glow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight option.
- Type
TextHighlightStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.highlight.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.includeCharMetrics option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
scene.layers.layers.texts.italic
OptionalPublished scene.layers.layers.texts.italic option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
scene.layers.layers.texts.layout
OptionalGrouped line height, spacing, and wrap bounds (see {@link resolveTextLayout}).
- Type
TextLayout- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.layout.letterSpacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.layout.lineHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.layout.maxHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.layout.maxWidth option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.layout.wordSpacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.letterSpacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.lineHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.maxHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.maxWidth option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.measurementCanvas option.
- Type
{ width?: number; height?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.measurementCanvas.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.measurementCanvas.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.overline.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Grouped alignment, baseline, and rotation (see {@link resolveTextPlacement}).
- Type
TextPlacement- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.placement.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.placement.textAlign option.
- Type
TextAlignMode- Default
- —
- Allowed
5 values
"center""left""right""start""end"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.placement.textBaseline option.
- Type
TextBaselineMode- Default
- —
- Allowed
6 values
"top""bottom""alphabetic""hanging""ideographic""middle"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.texts.shadow
OptionalPublished scene.layers.layers.texts.shadow option.
- Type
TextShadowStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.shadow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.strikethrough.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.texts.stroke
OptionalPublished scene.layers.layers.texts.stroke option.
- Type
TextStrokeStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.style option.
- Type
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"- Default
- —
- Allowed
6 values
"solid""dashed""dotted""groove""ridge""double"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.stroke.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.texts.text
RequiredPublished scene.layers.layers.texts.text option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.textAlign option.
- Type
TextAlignMode- Default
- —
- Allowed
5 values
"center""left""right""start""end"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.textBaseline option.
- Type
TextBaselineMode- Default
- —
- Allowed
6 values
"top""bottom""alphabetic""hanging""ideographic""middle"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.textOnCurve option.
- Type
TextCurveConfig- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.textOnCurve.baselineOffset option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.textOnCurve.layoutMode option.
- Type
CurvedTextLayoutMode- Default
- —
- Allowed
"fit""clamp""override"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.textOnCurve.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.textOnCurve.startAngleDeg option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.textOnCurve.sweepAngle option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.textOnCurve.up option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.underline.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.texts.wordSpacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.texts.x
RequiredPublished scene.layers.layers.texts.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.texts.y
RequiredPublished scene.layers.layers.texts.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.path
RequiredPublished scene.layers.layers.path option.
- Type
unknown- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.buffer
RequiredPublished scene.layers.layers.buffer option.
- Type
Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.globalAlpha
OptionalPublished scene.layers.layers.globalAlpha option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.globalCompositeOperation 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
scene.layers.layers.height
OptionalPublished scene.layers.layers.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.width
OptionalPublished scene.layers.layers.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.x
RequiredPublished scene.layers.layers.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.y
RequiredPublished scene.layers.layers.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.chartType
RequiredPublished scene.layers.layers.chartType option.
- Type
SceneChartType- Default
- Required
- Allowed
7 values
"pie""bar""horizontalBar""line""scatter""radar""polarArea"- Runtime
- node22, node24, node26
scene.layers.layers.data
RequiredPublished scene.layers.layers.data option.
- Type
unknown- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.opacity
OptionalPublished scene.layers.layers.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.lines
RequiredPublished scene.layers.layers.lines option.
- Type
CustomOptions | CustomOptions[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.lines.arrow
OptionalPublished scene.layers.layers.lines.arrow option.
- Type
{ start?: boolean; end?: boolean; size?: number; style?: "filled" | "outline"; color?: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.arrow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.arrow.end option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.arrow.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.arrow.start option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.arrow.style option.
- Type
"filled" | "outline"- Default
- —
- Allowed
"filled""outline"- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.endCoordinates option.
- Type
{ x: number; y: number; }- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.endCoordinates.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.endCoordinates.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle option.
- Type
{ width?: number; color?: string; gradient?: gradient; lineRadius?: string | number; lineJoin?: "round" | "bevel" | "miter"; lineCap?: "square" | "butt" | "round"; singleLine?: boolean; lineDash?: { dashArray?: number[]; offset?: number; }; pattern?: { type: "dots" | "custom" | "dashes"; segments?: number[]; offset?: number; }; texture?: string | Buffer<ArrayBufferLike>; stroke?: { color?: string; gradient?: gradient; width?: number; lineRadius?: string | number; lineCap?: "square" | "butt" | "round"; }; shadow?: { offsetX?: number; offsetY?: number; blur?: number; color?: string; gradient?: gradient; lineRadius?: string | number; }; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.lineCap option.
- Type
"square" | "butt" | "round"- Default
- —
- Allowed
"square""butt""round"- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.lineDash option.
- Type
{ dashArray?: number[]; offset?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.lineDash.dashArray option.
- Type
number[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.lineDash.offset option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.lineJoin option.
- Type
"round" | "bevel" | "miter"- Default
- —
- Allowed
"round""bevel""miter"- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.lineRadius option.
- Type
string | number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.pattern option.
- Type
{ type: "dots" | "custom" | "dashes"; segments?: number[]; offset?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.pattern.offset option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.pattern.segments option.
- Type
number[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.pattern.type option.
- Type
"dots" | "custom" | "dashes"- Default
- Required
- Allowed
"dots""custom""dashes"- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow option.
- Type
{ offsetX?: number; offsetY?: number; blur?: number; color?: string; gradient?: gradient; lineRadius?: string | number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.lineRadius option.
- Type
string | number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.singleLine option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke option.
- Type
{ color?: string; gradient?: gradient; width?: number; lineRadius?: string | number; lineCap?: "square" | "butt" | "round"; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.lineCap option.
- Type
"square" | "butt" | "round"- Default
- —
- Allowed
"square""butt""round"- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.lineRadius option.
- Type
string | number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.stroke.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.texture option.
- Type
string | Buffer<ArrayBufferLike>- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.lineStyle.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.markers option.
- Type
{ position: number; shape: "square" | "circle" | "diamond" | "arrow"; size: number; color: string; }[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.markers.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.markers.position option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.markers.shape option.
- Type
"square" | "circle" | "diamond" | "arrow"- Default
- Required
- Allowed
"square""circle""diamond""arrow"- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.markers.size option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.layers.lines.path
OptionalPublished scene.layers.layers.lines.path option.
- Type
{ type: "bezier" | "smooth" | "catmull-rom"; tension?: number; closed?: boolean; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.path.closed option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.path.tension option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.path.type option.
- Type
"bezier" | "smooth" | "catmull-rom"- Default
- Required
- Allowed
"bezier""smooth""catmull-rom"- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.startCoordinates option.
- Type
{ x: number; y: number; }- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.startCoordinates.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.layers.lines.startCoordinates.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.placement
RequiredPublished scene.layers.placement option.
- Type
SceneSurfacePlacement- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published scene.layers.placement.globalCompositeOperation 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
scene.layers.placement.height
RequiredPublished scene.layers.placement.height option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.placement.opacity
OptionalPublished scene.layers.placement.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.placement.rotation
OptionalPublished scene.layers.placement.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.placement.scaleX
OptionalPublished scene.layers.placement.scaleX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.placement.scaleY
OptionalPublished scene.layers.placement.scaleY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.placement.width
RequiredPublished scene.layers.placement.width option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.placement.x
RequiredPublished scene.layers.placement.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.layers.placement.y
RequiredPublished scene.layers.placement.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
scene.width
RequiredPublished scene.width option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.framesWithRepeats
OptionalPublished video.framesWithRepeats option.
- Type
SceneVideoFrameSlot[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.framesWithRepeats.repeat
OptionalPublished video.framesWithRepeats.repeat option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.framesWithRepeats.source
RequiredPublished video.framesWithRepeats.source option.
- Type
string | Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options
RequiredPublished video.options option.
- Type
VideoCreationOptions- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.addAnimatedText
OptionalPublished video.options.addAnimatedText option.
- Type
{ text: string; animation?: "zoom" | "rotate" | "fadeIn" | "fadeOut" | "slideIn" | "slideOut" | "bounce" | "typewriter"; startTime: number; endTime: number; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center" | { x: number; y: number; }; fontSize?: number; fontColor?: string; fontPath?: string; fontName?: string; fontFamily?: string; backgroundColor?: string; outputPath: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addAnimatedText.animation option.
- Type
"zoom" | "rotate" | "fadeIn" | "fadeOut" | "slideIn" | "slideOut" | "bounce" | "typewriter"- Default
- —
- Allowed
8 values
"zoom""rotate""fadeIn""fadeOut""slideIn""slideOut""bounce""typewriter"- Runtime
- node22, node24, node26
Published video.options.addAnimatedText.backgroundColor option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addAnimatedText.endTime option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addAnimatedText.fontColor option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addAnimatedText.fontFamily option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addAnimatedText.fontName option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addAnimatedText.fontPath option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addAnimatedText.fontSize option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addAnimatedText.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addAnimatedText.position option.
- Type
"center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center" | { x: number; y: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addAnimatedText.position.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addAnimatedText.position.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addAnimatedText.startTime option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addAnimatedText.text option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.addFade
OptionalPublished video.options.addFade option.
- Type
{ fadeIn?: number; fadeOut?: number; outputPath: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.addFade.fadeIn
OptionalPublished video.options.addFade.fadeIn option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.addFade.fadeOut
OptionalPublished video.options.addFade.fadeOut option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.addFade.outputPath
RequiredPublished video.options.addFade.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.addText
OptionalPublished video.options.addText option.
- Type
{ text: string; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center"; fontSize?: number; fontColor?: string; backgroundColor?: string; startTime?: number; endTime?: number; outputPath: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addText.backgroundColor option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.addText.endTime
OptionalPublished video.options.addText.endTime option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.addText.fontColor
OptionalPublished video.options.addText.fontColor option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.addText.fontSize
OptionalPublished video.options.addText.fontSize option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.addText.outputPath
RequiredPublished video.options.addText.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.addText.position
OptionalPublished video.options.addText.position option.
- Type
"center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center"- Default
- —
- Allowed
7 values
"center""top-left""top-right""bottom-left""bottom-right""top-center""bottom-center"- Runtime
- node22, node24, node26
video.options.addText.startTime
OptionalPublished video.options.addText.startTime option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.addText.text
RequiredPublished video.options.addText.text option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.addTextOverlay
OptionalPublished video.options.addTextOverlay option.
- Type
VideoTextOverlayOperation- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays option.
- Type
VideoTextOverlayClip[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.bold option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Grouped line decorations (`underline` / `overline` / `strikethrough`) and optional `bold` / `italic` flags for the canvas font string. Nested keys override the legacy flat fields (see {@link resolveTextDecorations}).
- Type
TextDecorations- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.bold option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.italic option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.overline.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.strikethrough.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.decorations.underline.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Grouped highlight, glow, and shadow. When set, entries override the legacy flat fields (see {@link resolveTextEffects}).
- Type
TextEffects- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow option.
- Type
TextGlowStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.glow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight option.
- Type
TextHighlightStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.highlight.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow option.
- Type
TextShadowStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.effects.shadow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Seconds when this overlay is hidden.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Grouped fill color / gradient and draw opacity (see {@link resolveTextFill}).
- Type
TextFill- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fill.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fill.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fill.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fill.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fill.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fill.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fill.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fill.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fill.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fill.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fill.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fill.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fill.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fill.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fill.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fill.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fill.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fill.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fill.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fill.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.font option.
- Type
{ size?: number; family?: string; name?: string; path?: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.font.family option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.font.name option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.font.path option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.font.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fontFamily option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fontName option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fontPath option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.fontSize option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow option.
- Type
TextGlowStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.glow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight option.
- Type
TextHighlightStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.highlight.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.includeCharMetrics option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.italic option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Grouped line height, spacing, and wrap bounds (see {@link resolveTextLayout}).
- Type
TextLayout- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.layout.letterSpacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.layout.lineHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.layout.maxHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.layout.maxWidth option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.layout.wordSpacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.letterSpacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.lineHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.maxHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.maxWidth option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.measurementCanvas option.
- Type
{ width?: number; height?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.measurementCanvas.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.measurementCanvas.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Master overlay opacity 0–1 (default `1`), multiplied with transition fades. Distinct from {@link TextProperties.fill} / `opacity` on glyphs.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.overline.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Grouped alignment, baseline, and rotation (see {@link resolveTextPlacement}).
- Type
TextPlacement- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.placement.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.placement.textAlign option.
- Type
TextAlignMode- Default
- —
- Allowed
5 values
"center""left""right""start""end"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.placement.textBaseline option.
- Type
TextBaselineMode- Default
- —
- Allowed
6 values
"top""bottom""alphabetic""hanging""ideographic""middle"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow option.
- Type
TextShadowStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.shadow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Seconds when this overlay becomes visible.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.strikethrough.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke option.
- Type
TextStrokeStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.style option.
- Type
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"- Default
- —
- Allowed
6 values
"solid""dashed""dotted""groove""ridge""double"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.stroke.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.text option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.textAlign option.
- Type
TextAlignMode- Default
- —
- Allowed
5 values
"center""left""right""start""end"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.textBaseline option.
- Type
TextBaselineMode- Default
- —
- Allowed
6 values
"top""bottom""alphabetic""hanging""ideographic""middle"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.textOnCurve option.
- Type
TextCurveConfig- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.textOnCurve.baselineOffset option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.textOnCurve.layoutMode option.
- Type
CurvedTextLayoutMode- Default
- —
- Allowed
"fit""clamp""override"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.textOnCurve.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.textOnCurve.startAngleDeg option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.textOnCurve.sweepAngle option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.textOnCurve.up option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.transitionIn option.
- Type
VideoTextTransition- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Advanced: override auto-built expressions (`t` variable, main video `w`/`h`). When set, merged with preset (preset fills missing keys).
- Type
{ x?: string; y?: string; alpha?: string; scale?: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.transitionIn.custom.alpha option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.transitionIn.custom.scale option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.transitionIn.custom.x option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.transitionIn.custom.y option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Seconds (default `0.35`).
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.transitionIn.type option.
- Type
VideoTextTransitionPreset- Default
- Required
- Allowed
14 values
"none""fade""fadeIn""fadeOut""slideIn""slideOut""slideLeft""slideRight""slideUp""slideDown""zoomIn""zoomOut""bounce""typewriter"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.transitionOut option.
- Type
VideoTextTransition- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Advanced: override auto-built expressions (`t` variable, main video `w`/`h`). When set, merged with preset (preset fills missing keys).
- Type
{ x?: string; y?: string; alpha?: string; scale?: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.transitionOut.custom.alpha option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.transitionOut.custom.scale option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.transitionOut.custom.x option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.transitionOut.custom.y option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Seconds (default `0.35`).
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.transitionOut.type option.
- Type
VideoTextTransitionPreset- Default
- Required
- Allowed
14 values
"none""fade""fadeIn""fadeOut""slideIn""slideOut""slideLeft""slideRight""slideUp""slideDown""zoomIn""zoomOut""bounce""typewriter"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.underline.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.wordSpacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTextOverlay.overlays.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.addTransition
OptionalPublished video.options.addTransition option.
- Type
{ type: "circle" | "blur" | "zoom" | "fade" | "wipe" | "slide" | "rotate" | "dissolve" | "pixelize"; duration: number; direction?: "left" | "right" | "up" | "down" | "in" | "out"; secondVideo?: VideoSource; outputPath: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTransition.direction option.
- Type
"left" | "right" | "up" | "down" | "in" | "out"- Default
- —
- Allowed
6 values
"left""right""up""down""in""out"- Runtime
- node22, node24, node26
Published video.options.addTransition.duration option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTransition.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addTransition.secondVideo option.
- Type
VideoSource- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.addTransition.type
RequiredPublished video.options.addTransition.type option.
- Type
"circle" | "blur" | "zoom" | "fade" | "wipe" | "slide" | "rotate" | "dissolve" | "pixelize"- Default
- Required
- Allowed
9 values
"circle""blur""zoom""fade""wipe""slide""rotate""dissolve""pixelize"- Runtime
- node22, node24, node26
video.options.addWatermark
OptionalPublished video.options.addWatermark option.
- Type
{ watermarkPath: VideoSource; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"; opacity?: number; size?: { width?: number; height?: number; fit?: VideoFit; }; marginX?: number; marginY?: number; startTime?: number; endTime?: number; outputPath: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addWatermark.endTime option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addWatermark.marginX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addWatermark.marginY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addWatermark.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addWatermark.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addWatermark.position option.
- Type
"center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"- Default
- —
- Allowed
5 values
"center""top-left""top-right""bottom-left""bottom-right"- Runtime
- node22, node24, node26
video.options.addWatermark.size
OptionalPublished video.options.addWatermark.size option.
- Type
{ width?: number; height?: number; fit?: VideoFit; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addWatermark.size.fit option.
- Type
VideoFit- Default
- —
- Allowed
"contain""cover""stretch"- Runtime
- node22, node24, node26
Published video.options.addWatermark.size.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addWatermark.size.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addWatermark.startTime option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.addWatermark.watermarkPath option.
- Type
VideoSource- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.adjustVolume
OptionalPublished video.options.adjustVolume option.
- Type
{ outputPath: string; volume?: number; ranges?: { start: number; end: number; volume: number; speed?: number; pitchSemitones?: number; }[]; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.adjustVolume.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.adjustVolume.ranges option.
- Type
{ start: number; end: number; volume: number; speed?: number; pitchSemitones?: number; }[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.adjustVolume.ranges.end option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.adjustVolume.ranges.pitchSemitones option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.adjustVolume.ranges.speed option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.adjustVolume.ranges.start option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.adjustVolume.ranges.volume option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.adjustVolume.volume option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.applyEffects
OptionalPublished video.options.applyEffects option.
- Type
{ filters: { type: "saturation" | "sharpen" | "noise" | "invert" | "grayscale" | "sepia" | "brightness" | "contrast" | "blur"; intensity?: number; value?: number; }[]; outputPath: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.applyEffects.filters option.
- Type
{ type: "saturation" | "sharpen" | "noise" | "invert" | "grayscale" | "sepia" | "brightness" | "contrast" | "blur"; intensity?: number; value?: number; }[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.applyEffects.filters.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.applyEffects.filters.type option.
- Type
"saturation" | "sharpen" | "noise" | "invert" | "grayscale" | "sepia" | "brightness" | "contrast" | "blur"- Default
- Required
- Allowed
9 values
"saturation""sharpen""noise""invert""grayscale""sepia""brightness""contrast""blur"- Runtime
- node22, node24, node26
Published video.options.applyEffects.filters.value option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.applyEffects.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.applyLUT
OptionalPublished video.options.applyLUT option.
- Type
{ lutPath: string; intensity?: number; outputPath: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.applyLUT.intensity
OptionalPublished video.options.applyLUT.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.applyLUT.lutPath
RequiredPublished video.options.applyLUT.lutPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.applyLUT.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.batch
OptionalPublished video.options.batch option.
- Type
{ videos: { source: VideoSource; operations: Record<string, unknown>; }[]; outputDirectory: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.batch.outputDirectory option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.batch.videos
RequiredPublished video.options.batch.videos option.
- Type
{ source: VideoSource; operations: Record<string, unknown>; }[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.batch.videos.operations option.
- Type
Record<string, unknown>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.batch.videos.source option.
- Type
VideoSource- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.changeSpeed
OptionalPublished video.options.changeSpeed option.
- Type
{ speed: number; outputPath: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.changeSpeed.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.changeSpeed.speed
RequiredPublished video.options.changeSpeed.speed option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.colorCorrect
OptionalPublished video.options.colorCorrect option.
- Type
{ brightness?: number; contrast?: number; saturation?: number; hue?: number; temperature?: number; outputPath: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.colorCorrect.brightness option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.colorCorrect.contrast option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.colorCorrect.hue
OptionalPublished video.options.colorCorrect.hue option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.colorCorrect.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.colorCorrect.saturation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.colorCorrect.temperature option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.compress
OptionalPublished video.options.compress option.
- Type
{ outputPath: string; quality?: VideoQuality; targetSize?: number; maxBitrate?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.compress.maxBitrate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.compress.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.compress.quality
OptionalPublished video.options.compress.quality option.
- Type
VideoQuality- Default
- —
- Allowed
"low""medium""high""ultra"- Runtime
- node22, node24, node26
Published video.options.compress.targetSize option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.convert
OptionalPublished video.options.convert option.
- Type
{ outputPath: string; format?: VideoOutputFormat; videoCodec?: "copy" | "libx264" | "libx265" | "libvpx-vp9" | "libaom-av1"; audioCodec?: "copy" | "none" | "aac" | "libopus" | "libvorbis" | "mp3"; pixelFormat?: "yuv420p" | "yuv422p" | "yuv444p" | "rgba"; quality?: VideoQuality; bitrate?: number; fps?: number; resolution?: { width?: number; height?: number; fit?: VideoFit; }; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.convert.audioCodec
OptionalPublished video.options.convert.audioCodec option.
- Type
"copy" | "none" | "aac" | "libopus" | "libvorbis" | "mp3"- Default
- —
- Allowed
6 values
"copy""none""aac""libopus""libvorbis""mp3"- Runtime
- node22, node24, node26
video.options.convert.bitrate
OptionalPublished video.options.convert.bitrate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.convert.format
OptionalPublished video.options.convert.format option.
- Type
VideoOutputFormat- Default
- —
- Allowed
5 values
"mp4""webm""avi""mov""mkv"- Runtime
- node22, node24, node26
video.options.convert.fps
OptionalPublished video.options.convert.fps option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.convert.outputPath
RequiredPublished video.options.convert.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.convert.pixelFormat option.
- Type
"yuv420p" | "yuv422p" | "yuv444p" | "rgba"- Default
- —
- Allowed
"yuv420p""yuv422p""yuv444p""rgba"- Runtime
- node22, node24, node26
video.options.convert.quality
OptionalPublished video.options.convert.quality option.
- Type
VideoQuality- Default
- —
- Allowed
"low""medium""high""ultra"- Runtime
- node22, node24, node26
video.options.convert.resolution
OptionalPublished video.options.convert.resolution option.
- Type
{ width?: number; height?: number; fit?: VideoFit; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.convert.resolution.fit option.
- Type
VideoFit- Default
- —
- Allowed
"contain""cover""stretch"- Runtime
- node22, node24, node26
Published video.options.convert.resolution.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.convert.resolution.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.convert.videoCodec
OptionalPublished video.options.convert.videoCodec option.
- Type
"copy" | "libx264" | "libx265" | "libvpx-vp9" | "libaom-av1"- Default
- —
- Allowed
5 values
"copy""libx264""libx265""libvpx-vp9""libaom-av1"- Runtime
- node22, node24, node26
video.options.createFromFrames
OptionalPublished video.options.createFromFrames option.
- Type
{ frames: VideoSource[]; outputPath: string; fps?: number; format?: VideoOutputFormat; quality?: VideoQuality; bitrate?: number; resolution?: { width?: number; height?: number; fit?: VideoFit; }; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.createFromFrames.bitrate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.createFromFrames.format option.
- Type
VideoOutputFormat- Default
- —
- Allowed
5 values
"mp4""webm""avi""mov""mkv"- Runtime
- node22, node24, node26
Published video.options.createFromFrames.fps option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.createFromFrames.frames option.
- Type
VideoSource[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.createFromFrames.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.createFromFrames.quality option.
- Type
VideoQuality- Default
- —
- Allowed
"low""medium""high""ultra"- Runtime
- node22, node24, node26
Published video.options.createFromFrames.resolution option.
- Type
{ width?: number; height?: number; fit?: VideoFit; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.createFromFrames.resolution.fit option.
- Type
VideoFit- Default
- —
- Allowed
"contain""cover""stretch"- Runtime
- node22, node24, node26
Published video.options.createFromFrames.resolution.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.createFromFrames.resolution.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.createLoop
OptionalPublished video.options.createLoop option.
- Type
{ outputPath: string; smooth?: boolean; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.createLoop.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.createLoop.smooth
OptionalPublished video.options.createLoop.smooth option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
video.options.createTimeLapse
OptionalPublished video.options.createTimeLapse option.
- Type
{ speed?: number; outputPath: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.createTimeLapse.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.createTimeLapse.speed option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.crop
OptionalPublished video.options.crop option.
- Type
{ x: number; y: number; width: number; height: number; outputPath: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.crop.height
RequiredPublished video.options.crop.height option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.crop.outputPath
RequiredPublished video.options.crop.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.crop.width
RequiredPublished video.options.crop.width option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.crop.x
RequiredPublished video.options.crop.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.crop.y
RequiredPublished video.options.crop.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.detectFormat
OptionalPublished video.options.detectFormat option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
video.options.detectScenes
OptionalPublished video.options.detectScenes option.
- Type
{ threshold?: number; outputPath?: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.detectScenes.outputPath option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.detectScenes.threshold option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.exportPreset
OptionalPublished video.options.exportPreset option.
- Type
{ preset: "youtube" | "instagram" | "tiktok" | "twitter" | "facebook" | "4k" | "1080p" | "720p" | "mobile" | "web"; outputPath: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.exportPreset.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.exportPreset.preset option.
- Type
"youtube" | "instagram" | "tiktok" | "twitter" | "facebook" | "4k" | "1080p" | "720p" | "mobile" | "web"- Default
- Required
- Allowed
10 values
"youtube""instagram""tiktok""twitter""facebook""4k""1080p""720p""mobile""web"- Runtime
- node22, node24, node26
video.options.extractAllFrames
OptionalPublished video.options.extractAllFrames option.
- Type
{ outputFormat?: "jpg" | "png"; outputDirectory?: string; quality?: number; prefix?: string; startTime?: number; endTime?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.extractAllFrames.endTime option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.extractAllFrames.outputDirectory option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.extractAllFrames.outputFormat option.
- Type
"jpg" | "png"- Default
- —
- Allowed
"jpg""png"- Runtime
- node22, node24, node26
Published video.options.extractAllFrames.prefix option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.extractAllFrames.quality option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.extractAllFrames.startTime option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.extractAudio
OptionalPublished video.options.extractAudio option.
- Type
{ outputPath: string; format?: "aac" | "mp3" | "wav" | "ogg"; bitrate?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.extractAudio.bitrate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.extractAudio.format option.
- Type
"aac" | "mp3" | "wav" | "ogg"- Default
- —
- Allowed
"aac""mp3""wav""ogg"- Runtime
- node22, node24, node26
Published video.options.extractAudio.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.extractFrame
OptionalPublished video.options.extractFrame option.
- Type
{ time?: number; frame?: number; width?: number; height?: number; outputFormat?: "jpg" | "png"; quality?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.extractFrame.frame
OptionalPublished video.options.extractFrame.frame option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.extractFrame.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.extractFrame.outputFormat option.
- Type
"jpg" | "png"- Default
- —
- Allowed
"jpg""png"- Runtime
- node22, node24, node26
Published video.options.extractFrame.quality option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.extractFrame.time
OptionalPublished video.options.extractFrame.time option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.extractFrame.width
OptionalPublished video.options.extractFrame.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.extractFrames
OptionalPublished video.options.extractFrames option.
- Type
{ times?: number[]; interval?: number; frameSelection?: { start?: number; end?: number; }; outputFormat?: "jpg" | "png"; quality?: number; outputDirectory?: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.extractFrames.frameSelection option.
- Type
{ start?: number; end?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.extractFrames.frameSelection.end option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.extractFrames.frameSelection.start option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.extractFrames.interval option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.extractFrames.outputDirectory option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.extractFrames.outputFormat option.
- Type
"jpg" | "png"- Default
- —
- Allowed
"jpg""png"- Runtime
- node22, node24, node26
Published video.options.extractFrames.quality option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.extractFrames.times option.
- Type
number[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.freezeFrame
OptionalPublished video.options.freezeFrame option.
- Type
{ time: number; duration: number; outputPath: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.freezeFrame.duration option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.freezeFrame.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.freezeFrame.time
RequiredPublished video.options.freezeFrame.time option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.generatePreview
OptionalPublished video.options.generatePreview option.
- Type
{ count?: number; outputDirectory?: string; outputFormat?: "jpg" | "png"; quality?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.generatePreview.count option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.generatePreview.outputDirectory option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.generatePreview.outputFormat option.
- Type
"jpg" | "png"- Default
- —
- Allowed
"jpg""png"- Runtime
- node22, node24, node26
Published video.options.generatePreview.quality option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.generateThumbnail
OptionalPublished video.options.generateThumbnail option.
- Type
{ count?: number; grid?: { cols: number; rows: number; }; width?: number; height?: number; outputFormat?: "jpg" | "png"; quality?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.generateThumbnail.count option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.generateThumbnail.grid option.
- Type
{ cols: number; rows: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.generateThumbnail.grid.cols option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.generateThumbnail.grid.rows option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.generateThumbnail.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.generateThumbnail.outputFormat option.
- Type
"jpg" | "png"- Default
- —
- Allowed
"jpg""png"- Runtime
- node22, node24, node26
Published video.options.generateThumbnail.quality option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.generateThumbnail.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.getInfo
OptionalPublished video.options.getInfo option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
video.options.merge
OptionalPublished video.options.merge option.
- Type
{ videos: VideoSource[]; outputPath: string; mode?: "grid" | "sequential" | "side-by-side"; direction?: "horizontal" | "vertical"; grid?: { cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }; audioPolicy?: VideoAudioPolicy; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.merge.audioPolicy
OptionalPublished video.options.merge.audioPolicy option.
- Type
VideoAudioPolicy- Default
- —
- Allowed
"none""preserve""first""mix"- Runtime
- node22, node24, node26
video.options.merge.direction
OptionalPublished video.options.merge.direction option.
- Type
"horizontal" | "vertical"- Default
- —
- Allowed
"horizontal""vertical"- Runtime
- node22, node24, node26
video.options.merge.grid
OptionalPublished video.options.merge.grid option.
- Type
{ cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.merge.grid.background option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.merge.grid.cellHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.merge.grid.cellWidth option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.merge.grid.cols
OptionalPublished video.options.merge.grid.cols option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.merge.grid.gap
OptionalPublished video.options.merge.grid.gap option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.merge.grid.rows
OptionalPublished video.options.merge.grid.rows option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.merge.mode
OptionalPublished video.options.merge.mode option.
- Type
"grid" | "sequential" | "side-by-side"- Default
- —
- Allowed
"grid""sequential""side-by-side"- Runtime
- node22, node24, node26
video.options.merge.outputPath
RequiredPublished video.options.merge.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.merge.videos
RequiredPublished video.options.merge.videos option.
- Type
VideoSource[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.mixAudio
OptionalPublished video.options.mixAudio option.
- Type
MixAudioOperation- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Output length policy. `video` is the stable default.
- Type
"video" | "shortest" | "longest"- Default
- —
- Allowed
"video""shortest""longest"- Runtime
- node22, node24, node26
Published video.options.mixAudio.keepOriginalAudio option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published video.options.mixAudio.originalPitchSemitones option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.mixAudio.originalSpeed option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.mixAudio.originalVolume option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.mixAudio.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.mixAudio.overlays
RequiredPublished video.options.mixAudio.overlays option.
- Type
MixAudioOverlayClip[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.mixAudio.overlays.duration option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.mixAudio.overlays.fadeIn option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.mixAudio.overlays.fadeOut option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Stereo pan from -1 (left) to +1 (right).
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.mixAudio.overlays.pitchSemitones option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.mixAudio.overlays.source option.
- Type
VideoSource- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.mixAudio.overlays.sourceStart option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.mixAudio.overlays.speed option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.mixAudio.overlays.startTime option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.mixAudio.overlays.volume option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.mute
OptionalPublished video.options.mute option.
- Type
{ outputPath: string; ranges?: { start: number; end: number; }[]; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.mute.outputPath
RequiredPublished video.options.mute.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.mute.ranges
OptionalPublished video.options.mute.ranges option.
- Type
{ start: number; end: number; }[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.mute.ranges.end
RequiredPublished video.options.mute.ranges.end option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.mute.ranges.start
RequiredPublished video.options.mute.ranges.start option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.normalizeAudio
OptionalPublished video.options.normalizeAudio option.
- Type
{ targetLevel?: number; method?: "peak" | "rms" | "lufs"; outputPath: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.normalizeAudio.method option.
- Type
"peak" | "rms" | "lufs"- Default
- —
- Allowed
"peak""rms""lufs"- Runtime
- node22, node24, node26
Published video.options.normalizeAudio.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.normalizeAudio.targetLevel option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.onProgress
OptionalPublished video.options.onProgress option.
- Type
(progress: FfmpegProgress) => void- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.overwrite
OptionalExisting output policy. Defaults to true for backward compatibility.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
video.options.pictureInPicture
OptionalPublished video.options.pictureInPicture option.
- Type
{ overlayVideo: VideoSource; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"; size?: { width?: number; height?: number; fit?: VideoFit; }; opacity?: number; outputPath: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.pictureInPicture.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.pictureInPicture.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.pictureInPicture.overlayVideo option.
- Type
VideoSource- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.pictureInPicture.position option.
- Type
"center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"- Default
- —
- Allowed
5 values
"center""top-left""top-right""bottom-left""bottom-right"- Runtime
- node22, node24, node26
Published video.options.pictureInPicture.size option.
- Type
{ width?: number; height?: number; fit?: VideoFit; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.pictureInPicture.size.fit option.
- Type
VideoFit- Default
- —
- Allowed
"contain""cover""stretch"- Runtime
- node22, node24, node26
Published video.options.pictureInPicture.size.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.pictureInPicture.size.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.removeAudio
OptionalPublished video.options.removeAudio option.
- Type
{ outputPath: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.removeAudio.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.replaceSegment
OptionalPublished video.options.replaceSegment option.
- Type
{ replacementVideo?: VideoSource; replacementStartTime?: number; replacementDuration?: number; replacementFrames?: VideoSource[]; replacementFps?: number; targetStartTime: number; targetEndTime: number; durationPolicy?: "fit" | "preserve" | "trim"; outputPath: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
fit scales replacement time to the target span; trim truncates/pads; preserve changes total duration.
- Type
"fit" | "preserve" | "trim"- Default
- —
- Allowed
"fit""preserve""trim"- Runtime
- node22, node24, node26
Published video.options.replaceSegment.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.replaceSegment.replacementDuration option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.replaceSegment.replacementFps option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.replaceSegment.replacementFrames option.
- Type
VideoSource[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.replaceSegment.replacementStartTime option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.replaceSegment.replacementVideo option.
- Type
VideoSource- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.replaceSegment.targetEndTime option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.replaceSegment.targetStartTime option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.reverse
OptionalPublished video.options.reverse option.
- Type
{ outputPath: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.reverse.outputPath
RequiredPublished video.options.reverse.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.rotate
OptionalPublished video.options.rotate option.
- Type
{ angle?: 90 | 180 | 270; flip?: "horizontal" | "vertical" | "both"; outputPath: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.rotate.angle
OptionalPublished video.options.rotate.angle option.
- Type
90 | 180 | 270- Default
- —
- Allowed
90180270- Runtime
- node22, node24, node26
video.options.rotate.flip
OptionalPublished video.options.rotate.flip option.
- Type
"horizontal" | "vertical" | "both"- Default
- —
- Allowed
"horizontal""vertical""both"- Runtime
- node22, node24, node26
video.options.rotate.outputPath
RequiredPublished video.options.rotate.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.signal
OptionalAbort remote resolution and the active FFmpeg/ffprobe process.
- Type
AbortSignal- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.source
RequiredPublished video.options.source option.
- Type
VideoSource- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.splitScreen
OptionalPublished video.options.splitScreen option.
- Type
{ videos: VideoSource[]; layout?: "grid" | "side-by-side" | "top-bottom"; grid?: { cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }; audioPolicy?: VideoAudioPolicy; outputPath: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.splitScreen.audioPolicy option.
- Type
VideoAudioPolicy- Default
- —
- Allowed
"none""preserve""first""mix"- Runtime
- node22, node24, node26
video.options.splitScreen.grid
OptionalPublished video.options.splitScreen.grid option.
- Type
{ cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.splitScreen.grid.background option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.splitScreen.grid.cellHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.splitScreen.grid.cellWidth option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.splitScreen.grid.cols option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.splitScreen.grid.gap option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.splitScreen.grid.rows option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.splitScreen.layout
OptionalPublished video.options.splitScreen.layout option.
- Type
"grid" | "side-by-side" | "top-bottom"- Default
- —
- Allowed
"grid""side-by-side""top-bottom"- Runtime
- node22, node24, node26
Published video.options.splitScreen.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.splitScreen.videos
RequiredPublished video.options.splitScreen.videos option.
- Type
VideoSource[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.stabilize
OptionalPublished video.options.stabilize option.
- Type
{ outputPath: string; smoothing?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.stabilize.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published video.options.stabilize.smoothing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.timeoutMs
OptionalPer-operation process timeout. Defaults to runtime FFmpeg policy.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.trim
OptionalAccurate mode re-encodes for timestamp precision; copy mode is keyframe-bound.
- Type
{ startTime: number; endTime: number; outputPath: string; mode?: "copy" | "accurate"; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.trim.endTime
RequiredPublished video.options.trim.endTime option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.trim.mode
OptionalPublished video.options.trim.mode option.
- Type
"copy" | "accurate"- Default
- —
- Allowed
"copy""accurate"- Runtime
- node22, node24, node26
video.options.trim.outputPath
RequiredPublished video.options.trim.outputPath option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.options.trim.startTime
RequiredPublished video.options.trim.startTime option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
video.prependComposedToFrames
OptionalPublished video.prependComposedToFrames option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
video.sceneRender
OptionalPublished video.sceneRender option.
- Type
SceneRenderOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Optional stricter surface depth cap. It may not exceed the configured runtime `maxSceneDepth`.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Resolve `$name`/`$value.path` asset tokens before painting.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
video.sceneRender.validate
OptionalPublished video.sceneRender.validate option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Types
SceneRenderInput: SceneRenderInput
- width
number - height
number - background?
SceneBackground: SceneBackground- customBg?
CanvasCustomBackground: CanvasCustomBackground- source
string - inherit?
boolean - fit?
FitMode- variant 1
"fill" - variant 2
"contain" - variant 3
"cover"
- variant 1
- align?
AlignMode- variant 1
"center" - variant 2
"top" - variant 3
"bottom" - variant 4
"left" - variant 5
"right" - variant 6
"top-left" - variant 7
"top-right" - variant 8
"bottom-left" - variant 9
"bottom-right"
- variant 1
- filters?
ImageFilter[]- variant 1
ImageFilter: ImageFilter- type
"saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize" - intensity?
number - radius?
number - angle?
number - centerX?
number - centerY?
number - value?
number - levels?
number - size?
number - x?
number - y?
number - width?
number - height?
number
- type
- variant 1
- opacity?
number
- source
- shadow?
ShadowOptions: ShadowOptions- color?
string - gradient?
gradient- variant 1
__type: { type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"linear" - startX?
number - startY?
number - endX?
number - endY?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 2
__type: { type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"radial" - startX?
number - startY?
number - startRadius?
number - endX?
number - endY?
number - endRadius?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 3
__type: { type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }- type
"conic" - centerX?
number - centerY?
number - startAngle?
number - rotate?
number - pivotX?
number - pivotY?
number - colors
GradientStop[]
- type
- variant 1
- offsetX?
number - offsetY?
number - blur?
number - opacity?
number - borderRadius?
number | "circular"- variant 1
number - variant 2
"circular"
- variant 1
- roundedCorners?
string - borderPosition?
string
- color?
- stroke?
StrokeOptions: StrokeOptions- color?
string - gradient?
gradient- variant 1
__type: { type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"linear" - startX?
number - startY?
number - endX?
number - endY?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 2
__type: { type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"radial" - startX?
number - startY?
number - startRadius?
number - endX?
number - endY?
number - endRadius?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 3
__type: { type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }- type
"conic" - centerX?
number - centerY?
number - startAngle?
number - rotate?
number - pivotX?
number - pivotY?
number - colors
GradientStop[]
- type
- variant 1
- width?
number - position?
number - blur?
number - opacity?
number - borderRadius?
number | "circular"- variant 1
number - variant 2
"circular"
- variant 1
- borderPosition?
string - roundedCorners?
string - style?
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"- variant 1
"solid" - variant 2
"dashed" - variant 3
"dotted" - variant 4
"groove" - variant 5
"ridge" - variant 6
"double"
- variant 1
- color?
- x?
number - y?
number - rotation?
number - opacity?
number - videoBg?
CanvasVideoBackground: CanvasVideoBackground- source
string | Buffer<ArrayBufferLike>- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- frame?
number - time?
number - format?
"jpg" | "png"- variant 1
"jpg" - variant 2
"png"
- variant 1
- quality?
number - loop?
boolean - autoplay?
boolean - inherit?
boolean - fit?
FitMode- variant 1
"fill" - variant 2
"contain" - variant 3
"cover"
- variant 1
- align?
AlignMode- variant 1
"center" - variant 2
"top" - variant 3
"bottom" - variant 4
"left" - variant 5
"right" - variant 6
"top-left" - variant 7
"top-right" - variant 8
"bottom-left" - variant 9
"bottom-right"
- variant 1
- filters?
ImageFilter[]- variant 1
ImageFilter: ImageFilter- type
"saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize" - intensity?
number - radius?
number - angle?
number - centerX?
number - centerY?
number - value?
number - levels?
number - size?
number - x?
number - y?
number - width?
number - height?
number
- type
- variant 1
- opacity?
number
- source
- colorBg?
string - gradientBg?
gradient- variant 1
__type: { type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"linear" - startX?
number - startY?
number - endX?
number - endY?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat"- variant 1
"repeat" - variant 2
"reflect" - variant 3
"no-repeat"
- variant 1
- colors
GradientStop[]- variant 1
GradientStop
- variant 1
- type
- variant 2
__type: { type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"radial" - startX?
number - startY?
number - startRadius?
number - endX?
number - endY?
number - endRadius?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat"- variant 1
"repeat" - variant 2
"reflect" - variant 3
"no-repeat"
- variant 1
- colors
GradientStop[]- variant 1
GradientStop
- variant 1
- type
- variant 3
__type: { type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }- type
"conic" - centerX?
number - centerY?
number - startAngle?
number - rotate?
number - pivotX?
number - pivotY?
number - colors
GradientStop[]- variant 1
GradientStop
- variant 1
- type
- variant 1
- patternBg?
PatternOptions: PatternOptions- type
"grid" | "dots" | "diagonal" | "stripes" | "waves" | "crosses" | "hexagons" | "checkerboard" | "diamonds" | "triangles" | "stars" | "polka" | "custom"- variant 1
"grid" - variant 2
"dots" - variant 3
"diagonal" - variant 4
"stripes" - variant 5
"waves" - variant 6
"crosses" - variant 7
"hexagons" - variant 8
"checkerboard" - variant 9
"diamonds" - variant 10
"triangles" - variant 11
"stars" - variant 12
"polka" - variant 13
"custom"
- variant 1
- color?
string - secondaryColor?
string - opacity?
number - size?
number - spacing?
number - rotation?
number - customPatternImage?
string - repeat?
"repeat" | "no-repeat" | "repeat-x" | "repeat-y"- variant 1
"repeat" - variant 2
"no-repeat" - variant 3
"repeat-x" - variant 4
"repeat-y"
- variant 1
- scale?
number - offsetX?
number - offsetY?
number - blendMode?
GlobalCompositeOperation- variant 1
"color" - variant 2
"color-burn" - variant 3
"color-dodge" - variant 4
"copy" - variant 5
"darken" - variant 6
"destination-atop" - variant 7
"destination-in" - variant 8
"destination-out" - variant 9
"destination-over" - variant 10
"difference" - variant 11
"exclusion" - variant 12
"hard-light" - variant 13
"hue" - variant 14
"lighten" - variant 15
"lighter" - variant 16
"luminosity" - variant 17
"multiply" - variant 18
"overlay" - variant 19
"saturation" - variant 20
"screen" - variant 21
"soft-light" - variant 22
"source-atop" - variant 23
"source-in" - variant 24
"source-out" - variant 25
"source-over" - variant 26
"xor"
- variant 1
- gradient?
GradientConfig: GradientConfig- type
"linear" | "radial" | "conic"- variant 1
"linear" - variant 2
"radial" - variant 3
"conic"
- variant 1
- 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"
- variant 1
- colors
{ stop: number; color: string; }[]- variant 1
{ stop: number; color: string; }
- variant 1
- type
- type
- noiseBg?
__type: { intensity?: number; }- intensity?
number
- intensity?
- transparentBase?
boolean - bgLayers?
BackgroundLayer[]- variant 1
BackgroundLayer- variant 1
__type: { type: "color"; value: string; opacity?: number; blendMode?: GlobalCompositeOperation; }- type
"color" - value
string - opacity?
number - blendMode?
GlobalCompositeOperation
- type
- variant 2
__type: { type: "gradient"; value: gradient; opacity?: number; blendMode?: GlobalCompositeOperation; }- type
"gradient" - value
gradient - opacity?
number - blendMode?
GlobalCompositeOperation
- type
- variant 3
__type: { type: "image"; source: string; opacity?: number; fit?: "fill" | "contain" | "cover"; align?: AlignMode; blendMode?: GlobalCompositeOperation; }- type
"image" - source
string - opacity?
number - fit?
"fill" | "contain" | "cover" - align?
AlignMode - blendMode?
GlobalCompositeOperation
- type
- variant 4
__type: { type: "pattern"; source: string; repeat?: BackgroundPatternRepeat; opacity?: number; blendMode?: GlobalCompositeOperation; }- type
"pattern" - source
string - repeat?
BackgroundPatternRepeat - opacity?
number - blendMode?
GlobalCompositeOperation
- type
- variant 5
__type: { type: "presetPattern"; pattern: PatternOptions; opacity?: number; blendMode?: GlobalCompositeOperation; }- type
"presetPattern" - pattern
PatternOptions - opacity?
number - blendMode?
GlobalCompositeOperation
- type
- variant 6
__type: { type: "noise"; intensity?: number; blendMode?: GlobalCompositeOperation; }- type
"noise" - intensity?
number - blendMode?
GlobalCompositeOperation
- type
- variant 1
- variant 1
- blendMode?
GlobalCompositeOperation- variant 1
"color" - variant 2
"color-burn" - variant 3
"color-dodge" - variant 4
"copy" - variant 5
"darken" - variant 6
"destination-atop" - variant 7
"destination-in" - variant 8
"destination-out" - variant 9
"destination-over" - variant 10
"difference" - variant 11
"exclusion" - variant 12
"hard-light" - variant 13
"hue" - variant 14
"lighten" - variant 15
"lighter" - variant 16
"luminosity" - variant 17
"multiply" - variant 18
"overlay" - variant 19
"saturation" - variant 20
"screen" - variant 21
"soft-light" - variant 22
"source-atop" - variant 23
"source-in" - variant 24
"source-out" - variant 25
"source-over" - variant 26
"xor"
- variant 1
- blur?
number - borderRadius?
number | "circular"- variant 1
number - variant 2
"circular"
- variant 1
- borderPosition?
string - zoom?
__type: { scale?: number; centerX?: number; centerY?: number; }- scale?
number - centerX?
number - centerY?
number
- scale?
- customBg?
- layers
SceneLayer[]- variant 1
SceneLayer- variant 1
__type: { type: "image"; images: ImageProperties | ImageProperties[]; options?: CreateImageOptions; }- type
"image" - images
ImageProperties | ImageProperties[]- variant 1
ImageProperties - variant 2
ImageProperties[]
- variant 1
- options?
CreateImageOptions: CreateImageOptions- isGrouped?
boolean - groupTransform?
GroupTransformOptions
- isGrouped?
- type
- variant 2
__type: { type: "text"; texts: TextProperties | TextProperties[]; }- type
"text" - texts
TextProperties | TextProperties[]- variant 1
TextProperties - variant 2
TextProperties[]
- variant 1
- type
- variant 3
__type: { type: "path"; path: unknown; options?: Path2DDrawOptions; }- type
"path" - path
unknown - options?
Path2DDrawOptions: Path2DDrawOptions- opacity?
number - globalCompositeOperation?
string - shadow?
{ color?: string; gradient?: gradient; blur?: number; offsetX?: number; offsetY?: number; } - gradientBounds?
{ x: number; y: number; w: number; h: number; } - stroke?
{ color?: string; gradient?: gradient; width?: number; lineCap?: "square" | "butt" | "round"; lineJoin?: "round" | "bevel" | "miter"; miterLimit?: number; style?: "solid" | "dashed" | "dotted"; dashArray?: number[]; dashOffset?: number; opacity?: number; } - fill?
{ color?: string; gradient?: gradient; opacity?: number; rule?: "nonzero" | "evenodd"; } - transform?
{ translateX?: number; translateY?: number; rotate?: number; scaleX?: number; scaleY?: number; originX?: number; originY?: number; }
- opacity?
- type
- variant 4
__type: { type: "imageBuffer"; buffer: Buffer<ArrayBufferLike>; x: number; y: number; width?: number; height?: number; globalAlpha?: number; globalCompositeOperation?: GlobalCompositeOperation; }- type
"imageBuffer" - buffer
Buffer<ArrayBufferLike> - x
number - y
number - width?
number - height?
number - globalAlpha?
number - globalCompositeOperation?
GlobalCompositeOperation- variant 1
"color" - variant 2
"color-burn" - variant 3
"color-dodge" - variant 4
"copy" - variant 5
"darken" - variant 6
"destination-atop" - variant 7
"destination-in" - variant 8
"destination-out" - variant 9
"destination-over" - variant 10
"difference" - variant 11
"exclusion" - variant 12
"hard-light" - variant 13
"hue" - variant 14
"lighten" - variant 15
"lighter" - variant 16
"luminosity" - variant 17
"multiply" - variant 18
"overlay" - variant 19
"saturation" - variant 20
"screen" - variant 21
"soft-light" - variant 22
"source-atop" - variant 23
"source-in" - variant 24
"source-out" - variant 25
"source-over" - variant 26
"xor"
- variant 1
- type
- variant 5
__type: { type: "chart"; chartType: SceneChartType; data: unknown; options?: unknown; x: number; y: number; width?: number; height?: number; opacity?: number; }- type
"chart" - chartType
SceneChartType- variant 1
"pie" - variant 2
"bar" - variant 3
"horizontalBar" - variant 4
"line" - variant 5
"scatter" - variant 6
"radar" - variant 7
"polarArea"
- variant 1
- data
unknown - options?
unknown - x
number - y
number - width?
number - height?
number - opacity?
number
- type
- variant 6
__type: { type: "chartComparison"; options: unknown; x: number; y: number; width?: number; height?: number; opacity?: number; }- type
"chartComparison" - options
unknown - x
number - y
number - width?
number - height?
number - opacity?
number
- type
- variant 7
__type: { type: "chartCombo"; options: unknown; x: number; y: number; width?: number; height?: number; opacity?: number; }- type
"chartCombo" - options
unknown - x
number - y
number - width?
number - height?
number - opacity?
number
- type
- variant 8
__type: { type: "customLines"; lines: CustomOptions | CustomOptions[]; }- type
"customLines" - lines
CustomOptions | CustomOptions[]- variant 1
CustomOptions - variant 2
CustomOptions[]
- variant 1
- type
- variant 9
__type: { type: "surface"; placement: SceneSurfacePlacement; background?: SceneBackground; layers: SceneLayer[]; }- type
"surface" - placement
SceneSurfacePlacement: SceneSurfacePlacement- x
number - y
number - width
number - height
number - opacity?
number - rotation?
number - scaleX?
number - scaleY?
number - globalCompositeOperation?
GlobalCompositeOperation
- x
- background?
SceneBackground: SceneBackground- customBg?
CanvasCustomBackground - shadow?
ShadowOptions - stroke?
StrokeOptions - x?
number - y?
number - rotation?
number - opacity?
number - videoBg?
CanvasVideoBackground - colorBg?
string - gradientBg?
gradient - patternBg?
PatternOptions - noiseBg?
{ intensity?: number; } - transparentBase?
boolean - bgLayers?
BackgroundLayer[] - blendMode?
GlobalCompositeOperation - blur?
number - borderRadius?
number | "circular" - borderPosition?
string - zoom?
{ scale?: number; centerX?: number; centerY?: number; }
- customBg?
- layers
SceneLayer[]- variant 1
SceneLayer
- variant 1
- type
- variant 1
- variant 1
__type: { options: VideoCreationOptions; prependComposedToFrames?: boolean; framesWithRepeats?: SceneVideoFrameSlot[]; sceneRender?: SceneRenderOptions; }
- options
VideoCreationOptions: VideoCreationOptions- source
VideoSource- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- getInfo?
boolean - extractFrame?
__type: { time?: number; frame?: number; width?: number; height?: number; outputFormat?: "jpg" | "png"; quality?: number; }- time?
number - frame?
number - width?
number - height?
number - outputFormat?
"jpg" | "png"- variant 1
"jpg" - variant 2
"png"
- variant 1
- quality?
number
- time?
- extractFrames?
__type: { times?: number[]; interval?: number; frameSelection?: { start?: number; end?: number; }; outputFormat?: "jpg" | "png"; quality?: number; outputDirectory?: string; }- times?
number[]- variant 1
number
- variant 1
- interval?
number - frameSelection?
__type: { start?: number; end?: number; }- start?
number - end?
number
- start?
- outputFormat?
"jpg" | "png"- variant 1
"jpg" - variant 2
"png"
- variant 1
- quality?
number - outputDirectory?
string
- times?
- extractAllFrames?
__type: { outputFormat?: "jpg" | "png"; outputDirectory?: string; quality?: number; prefix?: string; startTime?: number; endTime?: number; }- outputFormat?
"jpg" | "png"- variant 1
"jpg" - variant 2
"png"
- variant 1
- outputDirectory?
string - quality?
number - prefix?
string - startTime?
number - endTime?
number
- outputFormat?
- generateThumbnail?
__type: { count?: number; grid?: { cols: number; rows: number; }; width?: number; height?: number; outputFormat?: "jpg" | "png"; quality?: number; }- count?
number - grid?
__type: { cols: number; rows: number; }- cols
number - rows
number
- cols
- width?
number - height?
number - outputFormat?
"jpg" | "png"- variant 1
"jpg" - variant 2
"png"
- variant 1
- quality?
number
- count?
- convert?
__type: { outputPath: string; format?: VideoOutputFormat; videoCodec?: "copy" | "libx264" | "libx265" | "libvpx-vp9" | "libaom-av1"; audioCodec?: "copy" | "none" | "aac" | "libopus" | "libvorbis" | "mp3"; pixelFormat?: "yuv420p" | "yuv422p" | "yuv444p" | "rgba"; quality?: VideoQuality; bitrate?: number; fps?: number; resolution?: { width?: number; height?: number; fit?: VideoFit; }; }- outputPath
string - format?
VideoOutputFormat- variant 1
"mp4" - variant 2
"webm" - variant 3
"avi" - variant 4
"mov" - variant 5
"mkv"
- variant 1
- videoCodec?
"copy" | "libx264" | "libx265" | "libvpx-vp9" | "libaom-av1"- variant 1
"copy" - variant 2
"libx264" - variant 3
"libx265" - variant 4
"libvpx-vp9" - variant 5
"libaom-av1"
- variant 1
- audioCodec?
"copy" | "none" | "aac" | "libopus" | "libvorbis" | "mp3"- variant 1
"copy" - variant 2
"none" - variant 3
"aac" - variant 4
"libopus" - variant 5
"libvorbis" - variant 6
"mp3"
- variant 1
- pixelFormat?
"yuv420p" | "yuv422p" | "yuv444p" | "rgba"- variant 1
"yuv420p" - variant 2
"yuv422p" - variant 3
"yuv444p" - variant 4
"rgba"
- variant 1
- quality?
VideoQuality- variant 1
"low" - variant 2
"medium" - variant 3
"high" - variant 4
"ultra"
- variant 1
- bitrate?
number - fps?
number - resolution?
__type: { width?: number; height?: number; fit?: VideoFit; }- width?
number - height?
number - fit?
VideoFit- variant 1
"contain" - variant 2
"cover" - variant 3
"stretch"
- variant 1
- width?
- outputPath
- trim?
__type: { startTime: number; endTime: number; outputPath: string; mode?: "copy" | "accurate"; }- startTime
number - endTime
number - outputPath
string - mode?
"copy" | "accurate"- variant 1
"copy" - variant 2
"accurate"
- variant 1
- startTime
- extractAudio?
__type: { outputPath: string; format?: "aac" | "mp3" | "wav" | "ogg"; bitrate?: number; }- outputPath
string - format?
"aac" | "mp3" | "wav" | "ogg"- variant 1
"aac" - variant 2
"mp3" - variant 3
"wav" - variant 4
"ogg"
- variant 1
- bitrate?
number
- outputPath
- addWatermark?
__type: { watermarkPath: VideoSource; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"; opacity?: number; size?: { width?: number; height?: number; fit?: VideoFit; }; marginX?: number; marginY?: number; startTime?: number; endTime?: number; outputPath: string; }- watermarkPath
VideoSource- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- position?
"center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"- variant 1
"center" - variant 2
"top-left" - variant 3
"top-right" - variant 4
"bottom-left" - variant 5
"bottom-right"
- variant 1
- opacity?
number - size?
__type: { width?: number; height?: number; fit?: VideoFit; }- width?
number - height?
number - fit?
VideoFit- variant 1
"contain" - variant 2
"cover" - variant 3
"stretch"
- variant 1
- width?
- marginX?
number - marginY?
number - startTime?
number - endTime?
number - outputPath
string
- watermarkPath
- changeSpeed?
__type: { speed: number; outputPath: string; }- speed
number - outputPath
string
- speed
- generatePreview?
__type: { count?: number; outputDirectory?: string; outputFormat?: "jpg" | "png"; quality?: number; }- count?
number - outputDirectory?
string - outputFormat?
"jpg" | "png"- variant 1
"jpg" - variant 2
"png"
- variant 1
- quality?
number
- count?
- applyEffects?
__type: { filters: { type: "saturation" | "sharpen" | "noise" | "invert" | "grayscale" | "sepia" | "brightness" | "contrast" | "blur"; intensity?: number; value?: number; }[]; outputPath: string; }- filters
{ type: "saturation" | "sharpen" | "noise" | "invert" | "grayscale" | "sepia" | "brightness" | "contrast" | "blur"; intensity?: number; value?: number; }[]- variant 1
__type: { type: "saturation" | "sharpen" | "noise" | "invert" | "grayscale" | "sepia" | "brightness" | "contrast" | "blur"; intensity?: number; value?: number; }- type
"saturation" | "sharpen" | "noise" | "invert" | "grayscale" | "sepia" | "brightness" | "contrast" | "blur" - intensity?
number - value?
number
- type
- variant 1
- outputPath
string
- filters
- merge?
__type: { videos: VideoSource[]; outputPath: string; mode?: "grid" | "sequential" | "side-by-side"; direction?: "horizontal" | "vertical"; grid?: { cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }; audioPolicy?: VideoAudioPolicy; }- videos
VideoSource[]- variant 1
VideoSource- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- variant 1
- outputPath
string - mode?
"grid" | "sequential" | "side-by-side"- variant 1
"grid" - variant 2
"sequential" - variant 3
"side-by-side"
- variant 1
- direction?
"horizontal" | "vertical"- variant 1
"horizontal" - variant 2
"vertical"
- variant 1
- grid?
__type: { cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }- cols?
number - rows?
number - cellWidth?
number - cellHeight?
number - gap?
number - background?
string
- cols?
- audioPolicy?
VideoAudioPolicy- variant 1
"none" - variant 2
"preserve" - variant 3
"first" - variant 4
"mix"
- variant 1
- videos
- replaceSegment?
__type: { replacementVideo?: VideoSource; replacementStartTime?: number; replacementDuration?: number; replacementFrames?: VideoSource[]; replacementFps?: number; targetStartTime: number; targetEndTime: number; durationPolicy?: "fit" | "preserve" | "trim"; outputPath: string; }- replacementVideo?
VideoSource- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- replacementStartTime?
number - replacementDuration?
number - replacementFrames?
VideoSource[]- variant 1
VideoSource- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- variant 1
- replacementFps?
number - targetStartTime
number - targetEndTime
number - durationPolicy?
"fit" | "preserve" | "trim"- variant 1
"fit" - variant 2
"preserve" - variant 3
"trim"
- variant 1
- outputPath
string
- replacementVideo?
- rotate?
__type: { angle?: 90 | 180 | 270; flip?: "horizontal" | "vertical" | "both"; outputPath: string; }- angle?
90 | 180 | 270- variant 1
90 - variant 2
180 - variant 3
270
- variant 1
- flip?
"horizontal" | "vertical" | "both"- variant 1
"horizontal" - variant 2
"vertical" - variant 3
"both"
- variant 1
- outputPath
string
- angle?
- crop?
__type: { x: number; y: number; width: number; height: number; outputPath: string; }- x
number - y
number - width
number - height
number - outputPath
string
- x
- compress?
__type: { outputPath: string; quality?: VideoQuality; targetSize?: number; maxBitrate?: number; }- outputPath
string - quality?
VideoQuality- variant 1
"low" - variant 2
"medium" - variant 3
"high" - variant 4
"ultra"
- variant 1
- targetSize?
number - maxBitrate?
number
- outputPath
- addText?
__type: { text: string; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center"; fontSize?: number; fontColor?: string; backgroundColor?: string; startTime?: number; endTime?: number; outputPath: string; }- text
string - position?
"center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center"- variant 1
"center" - variant 2
"top-left" - variant 3
"top-right" - variant 4
"bottom-left" - variant 5
"bottom-right" - variant 6
"top-center" - variant 7
"bottom-center"
- variant 1
- fontSize?
number - fontColor?
string - backgroundColor?
string - startTime?
number - endTime?
number - outputPath
string
- text
- addFade?
__type: { fadeIn?: number; fadeOut?: number; outputPath: string; }- fadeIn?
number - fadeOut?
number - outputPath
string
- fadeIn?
- reverse?
__type: { outputPath: string; }- outputPath
string
- outputPath
- createLoop?
__type: { outputPath: string; smooth?: boolean; }- outputPath
string - smooth?
boolean
- outputPath
- batch?
__type: { videos: { source: VideoSource; operations: Record<string, unknown>; }[]; outputDirectory: string; }- videos
{ source: VideoSource; operations: Record<string, unknown>; }[]- variant 1
__type: { source: VideoSource; operations: Record<string, unknown>; }- source
VideoSource - operations
Record<string, unknown>
- source
- variant 1
- outputDirectory
string
- videos
- detectScenes?
__type: { threshold?: number; outputPath?: string; }- threshold?
number - outputPath?
string
- threshold?
- stabilize?
__type: { outputPath: string; smoothing?: number; }- outputPath
string - smoothing?
number
- outputPath
- colorCorrect?
__type: { brightness?: number; contrast?: number; saturation?: number; hue?: number; temperature?: number; outputPath: string; }- brightness?
number - contrast?
number - saturation?
number - hue?
number - temperature?
number - outputPath
string
- brightness?
- pictureInPicture?
__type: { overlayVideo: VideoSource; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"; size?: { width?: number; height?: number; fit?: VideoFit; }; opacity?: number; outputPath: string; }- overlayVideo
VideoSource- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- position?
"center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"- variant 1
"center" - variant 2
"top-left" - variant 3
"top-right" - variant 4
"bottom-left" - variant 5
"bottom-right"
- variant 1
- size?
__type: { width?: number; height?: number; fit?: VideoFit; }- width?
number - height?
number - fit?
VideoFit- variant 1
"contain" - variant 2
"cover" - variant 3
"stretch"
- variant 1
- width?
- opacity?
number - outputPath
string
- overlayVideo
- splitScreen?
__type: { videos: VideoSource[]; layout?: "grid" | "side-by-side" | "top-bottom"; grid?: { cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }; audioPolicy?: VideoAudioPolicy; outputPath: string; }- videos
VideoSource[]- variant 1
VideoSource- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- variant 1
- layout?
"grid" | "side-by-side" | "top-bottom"- variant 1
"grid" - variant 2
"side-by-side" - variant 3
"top-bottom"
- variant 1
- grid?
__type: { cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }- cols?
number - rows?
number - cellWidth?
number - cellHeight?
number - gap?
number - background?
string
- cols?
- audioPolicy?
VideoAudioPolicy- variant 1
"none" - variant 2
"preserve" - variant 3
"first" - variant 4
"mix"
- variant 1
- outputPath
string
- videos
- createTimeLapse?
__type: { speed?: number; outputPath: string; }- speed?
number - outputPath
string
- speed?
- removeAudio?
__type: { outputPath: string; }- outputPath
string
- outputPath
- mixAudio?
MixAudioOperation: MixAudioOperation- outputPath
string - overlays
MixAudioOverlayClip[]- variant 1
MixAudioOverlayClip: MixAudioOverlayClip- source
VideoSource - startTime
number - duration?
number - sourceStart?
number - volume?
number - speed?
number - pitchSemitones?
number - pan?
number - fadeIn?
number - fadeOut?
number
- source
- variant 1
- keepOriginalAudio?
boolean - originalVolume?
number - originalSpeed?
number - originalPitchSemitones?
number - durationPolicy?
"video" | "shortest" | "longest"- variant 1
"video" - variant 2
"shortest" - variant 3
"longest"
- variant 1
- outputPath
- mute?
__type: { outputPath: string; ranges?: { start: number; end: number; }[]; }- outputPath
string - ranges?
{ start: number; end: number; }[]- variant 1
__type: { start: number; end: number; }- start
number - end
number
- start
- variant 1
- outputPath
- adjustVolume?
__type: { outputPath: string; volume?: number; ranges?: { start: number; end: number; volume: number; speed?: number; pitchSemitones?: number; }[]; }- outputPath
string - volume?
number - ranges?
{ start: number; end: number; volume: number; speed?: number; pitchSemitones?: number; }[]- variant 1
__type: { start: number; end: number; volume: number; speed?: number; pitchSemitones?: number; }- start
number - end
number - volume
number - speed?
number - pitchSemitones?
number
- start
- variant 1
- outputPath
- createFromFrames?
__type: { frames: VideoSource[]; outputPath: string; fps?: number; format?: VideoOutputFormat; quality?: VideoQuality; bitrate?: number; resolution?: { width?: number; height?: number; fit?: VideoFit; }; }- frames
VideoSource[]- variant 1
VideoSource- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- variant 1
- outputPath
string - fps?
number - format?
VideoOutputFormat- variant 1
"mp4" - variant 2
"webm" - variant 3
"avi" - variant 4
"mov" - variant 5
"mkv"
- variant 1
- quality?
VideoQuality- variant 1
"low" - variant 2
"medium" - variant 3
"high" - variant 4
"ultra"
- variant 1
- bitrate?
number - resolution?
__type: { width?: number; height?: number; fit?: VideoFit; }- width?
number - height?
number - fit?
VideoFit- variant 1
"contain" - variant 2
"cover" - variant 3
"stretch"
- variant 1
- width?
- frames
- detectFormat?
boolean - freezeFrame?
__type: { time: number; duration: number; outputPath: string; }- time
number - duration
number - outputPath
string
- time
- exportPreset?
__type: { preset: "youtube" | "instagram" | "tiktok" | "twitter" | "facebook" | "4k" | "1080p" | "720p" | "mobile" | "web"; outputPath: string; }- preset
"youtube" | "instagram" | "tiktok" | "twitter" | "facebook" | "4k" | "1080p" | "720p" | "mobile" | "web"- variant 1
"youtube" - variant 2
"instagram" - variant 3
"tiktok" - variant 4
"twitter" - variant 5
"facebook" - variant 6
"4k" - variant 7
"1080p" - variant 8
"720p" - variant 9
"mobile" - variant 10
"web"
- variant 1
- outputPath
string
- preset
- normalizeAudio?
__type: { targetLevel?: number; method?: "peak" | "rms" | "lufs"; outputPath: string; }- targetLevel?
number - method?
"peak" | "rms" | "lufs"- variant 1
"peak" - variant 2
"rms" - variant 3
"lufs"
- variant 1
- outputPath
string
- targetLevel?
- applyLUT?
__type: { lutPath: string; intensity?: number; outputPath: string; }- lutPath
string - intensity?
number - outputPath
string
- lutPath
- addTransition?
__type: { type: "circle" | "blur" | "zoom" | "fade" | "wipe" | "slide" | "rotate" | "dissolve" | "pixelize"; duration: number; direction?: "left" | "right" | "up" | "down" | "in" | "out"; secondVideo?: VideoSource; outputPath: string; }- type
"circle" | "blur" | "zoom" | "fade" | "wipe" | "slide" | "rotate" | "dissolve" | "pixelize"- variant 1
"circle" - variant 2
"blur" - variant 3
"zoom" - variant 4
"fade" - variant 5
"wipe" - variant 6
"slide" - variant 7
"rotate" - variant 8
"dissolve" - variant 9
"pixelize"
- variant 1
- duration
number - direction?
"left" | "right" | "up" | "down" | "in" | "out"- variant 1
"left" - variant 2
"right" - variant 3
"up" - variant 4
"down" - variant 5
"in" - variant 6
"out"
- variant 1
- secondVideo?
VideoSource- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- outputPath
string
- type
- addTextOverlay?
VideoTextOverlayOperation: VideoTextOverlayOperation- overlays
VideoTextOverlayClip[]- variant 1
VideoTextOverlayClip: VideoTextOverlayClip- startTime
number - endTime
number - transitionIn?
VideoTextTransition - transitionOut?
VideoTextTransition - overlayOpacity?
number - text
string - x
number - y
number - font?
{ size?: number; family?: string; name?: string; path?: string; } - fontSize?
number - fontFamily?
string - fontName?
string - fontPath?
string - bold?
boolean - italic?
boolean - decorations?
TextDecorations - effects?
TextEffects - underline?
TextLineDecoration - overline?
TextLineDecoration - strikethrough?
TextLineDecoration - highlight?
TextHighlightStyle - glow?
TextGlowStyle - shadow?
TextShadowStyle - layout?
TextLayout - placement?
TextPlacement - fill?
TextFill - lineHeight?
number - letterSpacing?
number - wordSpacing?
number - maxWidth?
number - maxHeight?
number - textAlign?
TextAlignMode - textBaseline?
TextBaselineMode - rotation?
number - color?
string - gradient?
gradient - opacity?
number - stroke?
TextStrokeStyle - textOnCurve?
TextCurveConfig - includeCharMetrics?
boolean - measurementCanvas?
{ width?: number; height?: number; }
- startTime
- variant 1
- outputPath
string
- overlays
- addAnimatedText?
__type: { text: string; animation?: "zoom" | "rotate" | "fadeIn" | "fadeOut" | "slideIn" | "slideOut" | "bounce" | "typewriter"; startTime: number; endTime: number; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center" | { x: number; y: number; }; fontSize?: number; fontColor?: string; fontPath?: string; fontName?: string; fontFamily?: string; backgroundColor?: string; outputPath: string; }- text
string - animation?
"zoom" | "rotate" | "fadeIn" | "fadeOut" | "slideIn" | "slideOut" | "bounce" | "typewriter"- variant 1
"zoom" - variant 2
"rotate" - variant 3
"fadeIn" - variant 4
"fadeOut" - variant 5
"slideIn" - variant 6
"slideOut" - variant 7
"bounce" - variant 8
"typewriter"
- variant 1
- startTime
number - endTime
number - position?
"center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center" | { x: number; y: number; }- variant 1
"center" - variant 2
"top-left" - variant 3
"top-right" - variant 4
"bottom-left" - variant 5
"bottom-right" - variant 6
"top-center" - variant 7
"bottom-center" - variant 8
__type: { x: number; y: number; }- x
number - y
number
- x
- variant 1
- fontSize?
number - fontColor?
string - fontPath?
string - fontName?
string - fontFamily?
string - backgroundColor?
string - outputPath
string
- text
- signal?
AbortSignal - timeoutMs?
number - overwrite?
boolean - onProgress?
(progress: FfmpegProgress) => void
- source
- prependComposedToFrames?
boolean - framesWithRepeats?
SceneVideoFrameSlot[]- variant 1
SceneVideoFrameSlot- variant 1
string - variant 2
Buffer<ArrayBufferLike> - variant 3
__type: { source: string | Buffer<ArrayBufferLike>; repeat?: number; }- source
string | Buffer<ArrayBufferLike>- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- repeat?
number
- source
- variant 1
- variant 1
- sceneRender?
SceneRenderOptions: SceneRenderOptions- validate?
boolean - maxSurfaceDepth?
number - resolveAssetRefs?
boolean
- validate?
Return value
Promise<unknown>
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.