ApexPainter member
ApexPainter.createText
Published ApexPainter.createText method.
apexify.jsCURRENTnode22node24node26
Source: lib-next/apex-painter/main.ts (opens in a new tab)Signature
(textArray: TextProperties | TextProperties[], canvasBuffer: CanvasResults | Buffer, painterOpts?: PainterAssetRefsOptions) => Promise<Buffer>Parameters
textArray
TextProperties | TextProperties[]
canvasBuffer
Buffer<ArrayBufferLike> | CanvasResults
painterOpts?
Options
581 / 581 option paths
| Option | Type | Contract | Allowed values | Runtime & capabilities |
|---|---|---|---|---|
| textArray | ||||
textArray.boldPublished textArray.bold option.Deprecated | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
textArray.colorPublished textArray.color option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.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 |
textArray.decorations.boldPublished textArray.decorations.bold option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
textArray.decorations.italicPublished textArray.decorations.italic option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
textArray.decorations.overlinePublished textArray.decorations.overline option. | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.overline.colorPublished textArray.decorations.overline.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.overline.gradientPublished textArray.decorations.overline.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.overline.gradient.colorsPublished textArray.decorations.overline.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.decorations.overline.gradient.colors.colorPublished textArray.decorations.overline.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.decorations.overline.gradient.colors.stopPublished textArray.decorations.overline.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.decorations.overline.gradient.endXPublished textArray.decorations.overline.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.overline.gradient.endYPublished textArray.decorations.overline.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.overline.gradient.pivotXPublished textArray.decorations.overline.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.overline.gradient.pivotYPublished textArray.decorations.overline.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.overline.gradient.repeatPublished textArray.decorations.overline.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
textArray.decorations.overline.gradient.rotatePublished textArray.decorations.overline.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.overline.gradient.startXPublished textArray.decorations.overline.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.overline.gradient.startYPublished textArray.decorations.overline.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.overline.gradient.typePublished textArray.decorations.overline.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
textArray.decorations.overline.gradient.endRadiusPublished textArray.decorations.overline.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.overline.gradient.startRadiusPublished textArray.decorations.overline.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.overline.gradient.centerXPublished textArray.decorations.overline.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.overline.gradient.centerYPublished textArray.decorations.overline.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.overline.gradient.startAnglePublished textArray.decorations.overline.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.overline.widthPublished textArray.decorations.overline.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.strikethroughPublished textArray.decorations.strikethrough option. | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.strikethrough.colorPublished textArray.decorations.strikethrough.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.strikethrough.gradientPublished textArray.decorations.strikethrough.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.strikethrough.gradient.colorsPublished textArray.decorations.strikethrough.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.decorations.strikethrough.gradient.colors.colorPublished textArray.decorations.strikethrough.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.decorations.strikethrough.gradient.colors.stopPublished textArray.decorations.strikethrough.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.decorations.strikethrough.gradient.endXPublished textArray.decorations.strikethrough.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.strikethrough.gradient.endYPublished textArray.decorations.strikethrough.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.strikethrough.gradient.pivotXPublished textArray.decorations.strikethrough.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.strikethrough.gradient.pivotYPublished textArray.decorations.strikethrough.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.strikethrough.gradient.repeatPublished textArray.decorations.strikethrough.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
textArray.decorations.strikethrough.gradient.rotatePublished textArray.decorations.strikethrough.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.strikethrough.gradient.startXPublished textArray.decorations.strikethrough.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.strikethrough.gradient.startYPublished textArray.decorations.strikethrough.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.strikethrough.gradient.typePublished textArray.decorations.strikethrough.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
textArray.decorations.strikethrough.gradient.endRadiusPublished textArray.decorations.strikethrough.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.strikethrough.gradient.startRadiusPublished textArray.decorations.strikethrough.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.strikethrough.gradient.centerXPublished textArray.decorations.strikethrough.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.strikethrough.gradient.centerYPublished textArray.decorations.strikethrough.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.strikethrough.gradient.startAnglePublished textArray.decorations.strikethrough.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.strikethrough.widthPublished textArray.decorations.strikethrough.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.underlinePublished textArray.decorations.underline option. | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.underline.colorPublished textArray.decorations.underline.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.underline.gradientPublished textArray.decorations.underline.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.underline.gradient.colorsPublished textArray.decorations.underline.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.decorations.underline.gradient.colors.colorPublished textArray.decorations.underline.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.decorations.underline.gradient.colors.stopPublished textArray.decorations.underline.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.decorations.underline.gradient.endXPublished textArray.decorations.underline.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.underline.gradient.endYPublished textArray.decorations.underline.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.underline.gradient.pivotXPublished textArray.decorations.underline.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.underline.gradient.pivotYPublished textArray.decorations.underline.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.underline.gradient.repeatPublished textArray.decorations.underline.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
textArray.decorations.underline.gradient.rotatePublished textArray.decorations.underline.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.underline.gradient.startXPublished textArray.decorations.underline.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.underline.gradient.startYPublished textArray.decorations.underline.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.underline.gradient.typePublished textArray.decorations.underline.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
textArray.decorations.underline.gradient.endRadiusPublished textArray.decorations.underline.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.underline.gradient.startRadiusPublished textArray.decorations.underline.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.underline.gradient.centerXPublished textArray.decorations.underline.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.underline.gradient.centerYPublished textArray.decorations.underline.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.underline.gradient.startAnglePublished textArray.decorations.underline.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.decorations.underline.widthPublished textArray.decorations.underline.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effectsGrouped highlight, glow, and shadow. When set, entries override the legacy flat fields (see {@link resolveTextEffects}). | TextEffects | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.glowPublished textArray.effects.glow option. | TextGlowStyle | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.glow.colorPublished textArray.effects.glow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.glow.gradientPublished textArray.effects.glow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.glow.gradient.colorsPublished textArray.effects.glow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.effects.glow.gradient.colors.colorPublished textArray.effects.glow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.effects.glow.gradient.colors.stopPublished textArray.effects.glow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.effects.glow.gradient.endXPublished textArray.effects.glow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.glow.gradient.endYPublished textArray.effects.glow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.glow.gradient.pivotXPublished textArray.effects.glow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.glow.gradient.pivotYPublished textArray.effects.glow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.glow.gradient.repeatPublished textArray.effects.glow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
textArray.effects.glow.gradient.rotatePublished textArray.effects.glow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.glow.gradient.startXPublished textArray.effects.glow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.glow.gradient.startYPublished textArray.effects.glow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.glow.gradient.typePublished textArray.effects.glow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
textArray.effects.glow.gradient.endRadiusPublished textArray.effects.glow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.glow.gradient.startRadiusPublished textArray.effects.glow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.glow.gradient.centerXPublished textArray.effects.glow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.glow.gradient.centerYPublished textArray.effects.glow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.glow.gradient.startAnglePublished textArray.effects.glow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.glow.intensityPublished textArray.effects.glow.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.glow.opacityPublished textArray.effects.glow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.highlightPublished textArray.effects.highlight option. | TextHighlightStyle | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.highlight.colorPublished textArray.effects.highlight.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.highlight.gradientPublished textArray.effects.highlight.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.highlight.gradient.colorsPublished textArray.effects.highlight.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.effects.highlight.gradient.colors.colorPublished textArray.effects.highlight.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.effects.highlight.gradient.colors.stopPublished textArray.effects.highlight.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.effects.highlight.gradient.endXPublished textArray.effects.highlight.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.highlight.gradient.endYPublished textArray.effects.highlight.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.highlight.gradient.pivotXPublished textArray.effects.highlight.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.highlight.gradient.pivotYPublished textArray.effects.highlight.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.highlight.gradient.repeatPublished textArray.effects.highlight.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
textArray.effects.highlight.gradient.rotatePublished textArray.effects.highlight.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.highlight.gradient.startXPublished textArray.effects.highlight.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.highlight.gradient.startYPublished textArray.effects.highlight.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.highlight.gradient.typePublished textArray.effects.highlight.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
textArray.effects.highlight.gradient.endRadiusPublished textArray.effects.highlight.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.highlight.gradient.startRadiusPublished textArray.effects.highlight.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.highlight.gradient.centerXPublished textArray.effects.highlight.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.highlight.gradient.centerYPublished textArray.effects.highlight.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.highlight.gradient.startAnglePublished textArray.effects.highlight.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.highlight.opacityPublished textArray.effects.highlight.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.shadowPublished textArray.effects.shadow option. | TextShadowStyle | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.shadow.blurPublished textArray.effects.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.shadow.colorPublished textArray.effects.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.shadow.gradientPublished textArray.effects.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.shadow.gradient.colorsPublished textArray.effects.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.effects.shadow.gradient.colors.colorPublished textArray.effects.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.effects.shadow.gradient.colors.stopPublished textArray.effects.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.effects.shadow.gradient.endXPublished textArray.effects.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.shadow.gradient.endYPublished textArray.effects.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.shadow.gradient.pivotXPublished textArray.effects.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.shadow.gradient.pivotYPublished textArray.effects.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.shadow.gradient.repeatPublished textArray.effects.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
textArray.effects.shadow.gradient.rotatePublished textArray.effects.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.shadow.gradient.startXPublished textArray.effects.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.shadow.gradient.startYPublished textArray.effects.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.shadow.gradient.typePublished textArray.effects.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
textArray.effects.shadow.gradient.endRadiusPublished textArray.effects.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.shadow.gradient.startRadiusPublished textArray.effects.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.shadow.gradient.centerXPublished textArray.effects.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.shadow.gradient.centerYPublished textArray.effects.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.shadow.gradient.startAnglePublished textArray.effects.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.shadow.offsetXPublished textArray.effects.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.shadow.offsetYPublished textArray.effects.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.effects.shadow.opacityPublished textArray.effects.shadow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fillGrouped fill color / gradient and draw opacity (see {@link resolveTextFill}). | TextFill | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fill.colorPublished textArray.fill.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fill.gradientPublished textArray.fill.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fill.gradient.colorsPublished textArray.fill.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.fill.gradient.colors.colorPublished textArray.fill.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.fill.gradient.colors.stopPublished textArray.fill.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.fill.gradient.endXPublished textArray.fill.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fill.gradient.endYPublished textArray.fill.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fill.gradient.pivotXPublished textArray.fill.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fill.gradient.pivotYPublished textArray.fill.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fill.gradient.repeatPublished textArray.fill.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
textArray.fill.gradient.rotatePublished textArray.fill.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fill.gradient.startXPublished textArray.fill.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fill.gradient.startYPublished textArray.fill.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fill.gradient.typePublished textArray.fill.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
textArray.fill.gradient.endRadiusPublished textArray.fill.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fill.gradient.startRadiusPublished textArray.fill.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fill.gradient.centerXPublished textArray.fill.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fill.gradient.centerYPublished textArray.fill.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fill.gradient.startAnglePublished textArray.fill.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fill.opacityPublished textArray.fill.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fontPublished textArray.font option. | { size?: number; family?: string; name?: string; path?: string; } | OptionalDefault— | — | node22 · node24 · node26 |
textArray.font.familyPublished textArray.font.family option. | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.font.namePublished textArray.font.name option. | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.font.pathPublished textArray.font.path option. | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.font.sizePublished textArray.font.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fontFamilyPublished textArray.fontFamily option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fontNamePublished textArray.fontName option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fontPathPublished textArray.fontPath option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.fontSizePublished textArray.fontSize option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.glowPublished textArray.glow option.Deprecated | TextGlowStyle | OptionalDefault— | — | node22 · node24 · node26 |
textArray.glow.colorPublished textArray.glow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.glow.gradientPublished textArray.glow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
textArray.glow.gradient.colorsPublished textArray.glow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.glow.gradient.colors.colorPublished textArray.glow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.glow.gradient.colors.stopPublished textArray.glow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.glow.gradient.endXPublished textArray.glow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.glow.gradient.endYPublished textArray.glow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.glow.gradient.pivotXPublished textArray.glow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.glow.gradient.pivotYPublished textArray.glow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.glow.gradient.repeatPublished textArray.glow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
textArray.glow.gradient.rotatePublished textArray.glow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.glow.gradient.startXPublished textArray.glow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.glow.gradient.startYPublished textArray.glow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.glow.gradient.typePublished textArray.glow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
textArray.glow.gradient.endRadiusPublished textArray.glow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.glow.gradient.startRadiusPublished textArray.glow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.glow.gradient.centerXPublished textArray.glow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.glow.gradient.centerYPublished textArray.glow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.glow.gradient.startAnglePublished textArray.glow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.glow.intensityPublished textArray.glow.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.glow.opacityPublished textArray.glow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.gradientPublished textArray.gradient option.Deprecated | gradient | OptionalDefault— | — | node22 · node24 · node26 |
textArray.gradient.colorsPublished textArray.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.gradient.colors.colorPublished textArray.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.gradient.colors.stopPublished textArray.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.gradient.endXPublished textArray.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.gradient.endYPublished textArray.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.gradient.pivotXPublished textArray.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.gradient.pivotYPublished textArray.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.gradient.repeatPublished textArray.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
textArray.gradient.rotatePublished textArray.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.gradient.startXPublished textArray.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.gradient.startYPublished textArray.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.gradient.typePublished textArray.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
textArray.gradient.endRadiusPublished textArray.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.gradient.startRadiusPublished textArray.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.gradient.centerXPublished textArray.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.gradient.centerYPublished textArray.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.gradient.startAnglePublished textArray.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.highlightPublished textArray.highlight option.Deprecated | TextHighlightStyle | OptionalDefault— | — | node22 · node24 · node26 |
textArray.highlight.colorPublished textArray.highlight.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.highlight.gradientPublished textArray.highlight.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
textArray.highlight.gradient.colorsPublished textArray.highlight.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.highlight.gradient.colors.colorPublished textArray.highlight.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.highlight.gradient.colors.stopPublished textArray.highlight.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.highlight.gradient.endXPublished textArray.highlight.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.highlight.gradient.endYPublished textArray.highlight.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.highlight.gradient.pivotXPublished textArray.highlight.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.highlight.gradient.pivotYPublished textArray.highlight.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.highlight.gradient.repeatPublished textArray.highlight.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
textArray.highlight.gradient.rotatePublished textArray.highlight.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.highlight.gradient.startXPublished textArray.highlight.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.highlight.gradient.startYPublished textArray.highlight.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.highlight.gradient.typePublished textArray.highlight.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
textArray.highlight.gradient.endRadiusPublished textArray.highlight.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.highlight.gradient.startRadiusPublished textArray.highlight.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.highlight.gradient.centerXPublished textArray.highlight.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.highlight.gradient.centerYPublished textArray.highlight.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.highlight.gradient.startAnglePublished textArray.highlight.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.highlight.opacityPublished textArray.highlight.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.includeCharMetricsPublished textArray.includeCharMetrics option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
textArray.italicPublished textArray.italic option.Deprecated | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
textArray.layoutGrouped line height, spacing, and wrap bounds (see {@link resolveTextLayout}). | TextLayout | OptionalDefault— | — | node22 · node24 · node26 |
textArray.layout.letterSpacingPublished textArray.layout.letterSpacing option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.layout.lineHeightPublished textArray.layout.lineHeight option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.layout.maxHeightPublished textArray.layout.maxHeight option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.layout.maxWidthPublished textArray.layout.maxWidth option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.layout.wordSpacingPublished textArray.layout.wordSpacing option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.letterSpacingPublished textArray.letterSpacing option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.lineHeightPublished textArray.lineHeight option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.maxHeightPublished textArray.maxHeight option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.maxWidthPublished textArray.maxWidth option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.measurementCanvasPublished textArray.measurementCanvas option. | { width?: number; height?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
textArray.measurementCanvas.heightPublished textArray.measurementCanvas.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.measurementCanvas.widthPublished textArray.measurementCanvas.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.opacityPublished textArray.opacity option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.overlinePublished textArray.overline option.Deprecated | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
textArray.overline.colorPublished textArray.overline.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.overline.gradientPublished textArray.overline.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
textArray.overline.gradient.colorsPublished textArray.overline.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.overline.gradient.colors.colorPublished textArray.overline.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.overline.gradient.colors.stopPublished textArray.overline.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.overline.gradient.endXPublished textArray.overline.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.overline.gradient.endYPublished textArray.overline.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.overline.gradient.pivotXPublished textArray.overline.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.overline.gradient.pivotYPublished textArray.overline.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.overline.gradient.repeatPublished textArray.overline.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
textArray.overline.gradient.rotatePublished textArray.overline.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.overline.gradient.startXPublished textArray.overline.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.overline.gradient.startYPublished textArray.overline.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.overline.gradient.typePublished textArray.overline.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
textArray.overline.gradient.endRadiusPublished textArray.overline.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.overline.gradient.startRadiusPublished textArray.overline.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.overline.gradient.centerXPublished textArray.overline.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.overline.gradient.centerYPublished textArray.overline.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.overline.gradient.startAnglePublished textArray.overline.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.overline.widthPublished textArray.overline.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.placementGrouped alignment, baseline, and rotation (see {@link resolveTextPlacement}). | TextPlacement | OptionalDefault— | — | node22 · node24 · node26 |
textArray.placement.rotationPublished textArray.placement.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.placement.textAlignPublished textArray.placement.textAlign option. | TextAlignMode | OptionalDefault— | 5 values"center" "left" "right" "start" "end" | node22 · node24 · node26 |
textArray.placement.textBaselinePublished textArray.placement.textBaseline option. | TextBaselineMode | OptionalDefault— | 6 values"top" "bottom" "alphabetic" "hanging" "ideographic" "middle" | node22 · node24 · node26 |
textArray.rotationPublished textArray.rotation option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.shadowPublished textArray.shadow option.Deprecated | TextShadowStyle | OptionalDefault— | — | node22 · node24 · node26 |
textArray.shadow.blurPublished textArray.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.shadow.colorPublished textArray.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.shadow.gradientPublished textArray.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
textArray.shadow.gradient.colorsPublished textArray.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.shadow.gradient.colors.colorPublished textArray.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.shadow.gradient.colors.stopPublished textArray.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.shadow.gradient.endXPublished textArray.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.shadow.gradient.endYPublished textArray.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.shadow.gradient.pivotXPublished textArray.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.shadow.gradient.pivotYPublished textArray.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.shadow.gradient.repeatPublished textArray.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
textArray.shadow.gradient.rotatePublished textArray.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.shadow.gradient.startXPublished textArray.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.shadow.gradient.startYPublished textArray.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.shadow.gradient.typePublished textArray.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
textArray.shadow.gradient.endRadiusPublished textArray.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.shadow.gradient.startRadiusPublished textArray.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.shadow.gradient.centerXPublished textArray.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.shadow.gradient.centerYPublished textArray.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.shadow.gradient.startAnglePublished textArray.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.shadow.offsetXPublished textArray.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.shadow.offsetYPublished textArray.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.shadow.opacityPublished textArray.shadow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.strikethroughPublished textArray.strikethrough option.Deprecated | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
textArray.strikethrough.colorPublished textArray.strikethrough.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.strikethrough.gradientPublished textArray.strikethrough.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
textArray.strikethrough.gradient.colorsPublished textArray.strikethrough.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.strikethrough.gradient.colors.colorPublished textArray.strikethrough.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.strikethrough.gradient.colors.stopPublished textArray.strikethrough.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.strikethrough.gradient.endXPublished textArray.strikethrough.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.strikethrough.gradient.endYPublished textArray.strikethrough.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.strikethrough.gradient.pivotXPublished textArray.strikethrough.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.strikethrough.gradient.pivotYPublished textArray.strikethrough.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.strikethrough.gradient.repeatPublished textArray.strikethrough.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
textArray.strikethrough.gradient.rotatePublished textArray.strikethrough.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.strikethrough.gradient.startXPublished textArray.strikethrough.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.strikethrough.gradient.startYPublished textArray.strikethrough.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.strikethrough.gradient.typePublished textArray.strikethrough.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
textArray.strikethrough.gradient.endRadiusPublished textArray.strikethrough.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.strikethrough.gradient.startRadiusPublished textArray.strikethrough.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.strikethrough.gradient.centerXPublished textArray.strikethrough.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.strikethrough.gradient.centerYPublished textArray.strikethrough.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.strikethrough.gradient.startAnglePublished textArray.strikethrough.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.strikethrough.widthPublished textArray.strikethrough.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.strokePublished textArray.stroke option. | TextStrokeStyle | OptionalDefault— | — | node22 · node24 · node26 |
textArray.stroke.colorPublished textArray.stroke.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.stroke.gradientPublished textArray.stroke.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
textArray.stroke.gradient.colorsPublished textArray.stroke.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.stroke.gradient.colors.colorPublished textArray.stroke.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.stroke.gradient.colors.stopPublished textArray.stroke.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.stroke.gradient.endXPublished textArray.stroke.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.stroke.gradient.endYPublished textArray.stroke.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.stroke.gradient.pivotXPublished textArray.stroke.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.stroke.gradient.pivotYPublished textArray.stroke.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.stroke.gradient.repeatPublished textArray.stroke.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
textArray.stroke.gradient.rotatePublished textArray.stroke.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.stroke.gradient.startXPublished textArray.stroke.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.stroke.gradient.startYPublished textArray.stroke.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.stroke.gradient.typePublished textArray.stroke.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
textArray.stroke.gradient.endRadiusPublished textArray.stroke.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.stroke.gradient.startRadiusPublished textArray.stroke.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.stroke.gradient.centerXPublished textArray.stroke.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.stroke.gradient.centerYPublished textArray.stroke.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.stroke.gradient.startAnglePublished textArray.stroke.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.stroke.opacityPublished textArray.stroke.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.stroke.stylePublished textArray.stroke.style option. | "solid" | "dashed" | "dotted" | "groove" | "ridge" | "double" | OptionalDefault— | 6 values"solid" "dashed" "dotted" "groove" "ridge" "double" | node22 · node24 · node26 |
textArray.stroke.widthPublished textArray.stroke.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.textPublished textArray.text option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.textAlignPublished textArray.textAlign option.Deprecated | TextAlignMode | OptionalDefault— | 5 values"center" "left" "right" "start" "end" | node22 · node24 · node26 |
textArray.textBaselinePublished textArray.textBaseline option.Deprecated | TextBaselineMode | OptionalDefault— | 6 values"top" "bottom" "alphabetic" "hanging" "ideographic" "middle" | node22 · node24 · node26 |
textArray.textOnCurvePublished textArray.textOnCurve option.Deprecated | TextCurveConfig | OptionalDefault— | — | node22 · node24 · node26 |
textArray.textOnCurve.baselineOffsetPublished textArray.textOnCurve.baselineOffset option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.textOnCurve.layoutModePublished textArray.textOnCurve.layoutMode option. | CurvedTextLayoutMode | OptionalDefault— | "fit" "clamp" "override" | node22 · node24 · node26 |
textArray.textOnCurve.radiusPublished textArray.textOnCurve.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.textOnCurve.startAngleDegPublished textArray.textOnCurve.startAngleDeg option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.textOnCurve.sweepAnglePublished textArray.textOnCurve.sweepAngle option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.textOnCurve.upPublished textArray.textOnCurve.up option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
textArray.underlinePublished textArray.underline option.Deprecated | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
textArray.underline.colorPublished textArray.underline.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
textArray.underline.gradientPublished textArray.underline.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
textArray.underline.gradient.colorsPublished textArray.underline.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.underline.gradient.colors.colorPublished textArray.underline.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.underline.gradient.colors.stopPublished textArray.underline.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.underline.gradient.endXPublished textArray.underline.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.underline.gradient.endYPublished textArray.underline.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.underline.gradient.pivotXPublished textArray.underline.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.underline.gradient.pivotYPublished textArray.underline.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.underline.gradient.repeatPublished textArray.underline.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
textArray.underline.gradient.rotatePublished textArray.underline.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.underline.gradient.startXPublished textArray.underline.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.underline.gradient.startYPublished textArray.underline.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.underline.gradient.typePublished textArray.underline.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
textArray.underline.gradient.endRadiusPublished textArray.underline.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.underline.gradient.startRadiusPublished textArray.underline.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.underline.gradient.centerXPublished textArray.underline.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.underline.gradient.centerYPublished textArray.underline.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.underline.gradient.startAnglePublished textArray.underline.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.underline.widthPublished textArray.underline.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.wordSpacingPublished textArray.wordSpacing option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
textArray.xPublished textArray.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
textArray.yPublished textArray.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
| canvasBuffer | ||||
canvasBuffer.bufferPublished canvasBuffer.buffer option. | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvasPublished canvasBuffer.canvas option. | CanvasConfig | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayersPublished canvasBuffer.canvas.bgLayers option. | BackgroundLayer[] | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.blendModePublished canvasBuffer.canvas.bgLayers.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.opacityPublished canvasBuffer.canvas.bgLayers.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.typePublished canvasBuffer.canvas.bgLayers.type option. | "color" | RequiredDefaultRequired | "color" | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.valuePublished canvasBuffer.canvas.bgLayers.value option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.alignPublished canvasBuffer.canvas.bgLayers.align option. | AlignMode | OptionalDefault— | 9 values"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.fitPublished canvasBuffer.canvas.bgLayers.fit option. | "fill" | "contain" | "cover" | OptionalDefault— | "fill" "contain" "cover" | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.sourcePublished canvasBuffer.canvas.bgLayers.source option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.repeatPublished canvasBuffer.canvas.bgLayers.repeat option. | BackgroundPatternRepeat | OptionalDefault— | "repeat" "no-repeat" "repeat-x" "repeat-y" | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.patternPublished canvasBuffer.canvas.bgLayers.pattern option. | PatternOptions | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.blendModePublished canvasBuffer.canvas.bgLayers.pattern.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.colorPublished canvasBuffer.canvas.bgLayers.pattern.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.customPatternImagePublished canvasBuffer.canvas.bgLayers.pattern.customPatternImage option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradientPublished canvasBuffer.canvas.bgLayers.pattern.gradient option. | GradientConfig | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.anglePublished canvasBuffer.canvas.bgLayers.pattern.gradient.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.centerXPublished canvasBuffer.canvas.bgLayers.pattern.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.centerYPublished canvasBuffer.canvas.bgLayers.pattern.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.colorsPublished canvasBuffer.canvas.bgLayers.pattern.gradient.colors option. | { stop: number; color: string; }[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.colors.colorPublished canvasBuffer.canvas.bgLayers.pattern.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.colors.stopPublished canvasBuffer.canvas.bgLayers.pattern.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.endRadiusPublished canvasBuffer.canvas.bgLayers.pattern.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.endXPublished canvasBuffer.canvas.bgLayers.pattern.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.endYPublished canvasBuffer.canvas.bgLayers.pattern.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.repeatPublished canvasBuffer.canvas.bgLayers.pattern.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.startAnglePublished canvasBuffer.canvas.bgLayers.pattern.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.startRadiusPublished canvasBuffer.canvas.bgLayers.pattern.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.startXPublished canvasBuffer.canvas.bgLayers.pattern.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.startYPublished canvasBuffer.canvas.bgLayers.pattern.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.gradient.typePublished canvasBuffer.canvas.bgLayers.pattern.gradient.type option. | "linear" | "radial" | "conic" | RequiredDefaultRequired | "linear" "radial" "conic" | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.offsetXPublished canvasBuffer.canvas.bgLayers.pattern.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.offsetYPublished canvasBuffer.canvas.bgLayers.pattern.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.opacityPublished canvasBuffer.canvas.bgLayers.pattern.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.repeatPublished canvasBuffer.canvas.bgLayers.pattern.repeat option. | "repeat" | "no-repeat" | "repeat-x" | "repeat-y" | OptionalDefault— | "repeat" "no-repeat" "repeat-x" "repeat-y" | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.rotationPublished canvasBuffer.canvas.bgLayers.pattern.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.scalePublished canvasBuffer.canvas.bgLayers.pattern.scale option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.secondaryColorPublished canvasBuffer.canvas.bgLayers.pattern.secondaryColor option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.sizePublished canvasBuffer.canvas.bgLayers.pattern.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.spacingPublished canvasBuffer.canvas.bgLayers.pattern.spacing option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.pattern.typePublished canvasBuffer.canvas.bgLayers.pattern.type option. | "grid" | "dots" | "diagonal" | "stripes" | "waves" | "crosses" | "hexagons" | "checkerboard" | "diamonds" | "triangles" | "stars" | "polka" | "custom" | RequiredDefaultRequired | 13 values"grid" "dots" "diagonal" "stripes" "waves" "crosses" "hexagons" "checkerboard" "diamonds" "triangles" "stars" "polka" "custom" | node22 · node24 · node26 |
canvasBuffer.canvas.bgLayers.intensityPublished canvasBuffer.canvas.bgLayers.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.blendModePublished canvasBuffer.canvas.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
canvasBuffer.canvas.blurPublished canvasBuffer.canvas.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.borderPositionPublished canvasBuffer.canvas.borderPosition option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.borderRadiusPublished canvasBuffer.canvas.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.colorBgPublished canvasBuffer.canvas.colorBg option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBgPublished canvasBuffer.canvas.customBg option. | CanvasCustomBackground | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.alignPlacement used by `contain` / `cover` when `inherit` is false. | AlignMode | OptionalDefault— | 9 values"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filtersImage filters applied to this background only. | ImageFilter[] | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.anglePublished canvasBuffer.canvas.customBg.filters.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.centerXPublished canvasBuffer.canvas.customBg.filters.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.centerYPublished canvasBuffer.canvas.customBg.filters.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.heightPublished canvasBuffer.canvas.customBg.filters.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.intensityPublished canvasBuffer.canvas.customBg.filters.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.levelsPublished canvasBuffer.canvas.customBg.filters.levels option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.radiusPublished canvasBuffer.canvas.customBg.filters.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.sizePublished canvasBuffer.canvas.customBg.filters.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.typePublished canvasBuffer.canvas.customBg.filters.type option. | "saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize" | RequiredDefaultRequired | 17 values"saturation" "gaussianBlur" "motionBlur" "radialBlur" "sharpen" "noise" "grain" "edgeDetection" "emboss" "invert" "grayscale" "sepia" "pixelate" "brightness" "contrast" "hueShift" "posterize" | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.valuePublished canvasBuffer.canvas.customBg.filters.value option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.widthPublished canvasBuffer.canvas.customBg.filters.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.xOptional pixelate region. Omit for the whole filtered surface. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.filters.yPublished canvasBuffer.canvas.customBg.filters.y option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.fitResize policy when `inherit` is false. | FitMode | OptionalDefault— | "fill" "contain" "cover" | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.inheritAdopt the source image dimensions as the canvas dimensions. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.opacityBackground-image opacity, multiplied by the canvas-level opacity. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.customBg.sourcePublished canvasBuffer.canvas.customBg.source option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBgPublished canvasBuffer.canvas.gradientBg option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.colorsPublished canvasBuffer.canvas.gradientBg.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.colors.colorPublished canvasBuffer.canvas.gradientBg.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.colors.stopPublished canvasBuffer.canvas.gradientBg.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.endXPublished canvasBuffer.canvas.gradientBg.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.endYPublished canvasBuffer.canvas.gradientBg.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.pivotXPublished canvasBuffer.canvas.gradientBg.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.pivotYPublished canvasBuffer.canvas.gradientBg.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.repeatPublished canvasBuffer.canvas.gradientBg.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.rotatePublished canvasBuffer.canvas.gradientBg.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.startXPublished canvasBuffer.canvas.gradientBg.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.startYPublished canvasBuffer.canvas.gradientBg.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.typePublished canvasBuffer.canvas.gradientBg.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.endRadiusPublished canvasBuffer.canvas.gradientBg.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.startRadiusPublished canvasBuffer.canvas.gradientBg.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.centerXPublished canvasBuffer.canvas.gradientBg.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.centerYPublished canvasBuffer.canvas.gradientBg.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.gradientBg.startAnglePublished canvasBuffer.canvas.gradientBg.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.heightPublished canvasBuffer.canvas.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.noiseBgPublished canvasBuffer.canvas.noiseBg option. | { intensity?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.noiseBg.intensityPublished canvasBuffer.canvas.noiseBg.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.opacityPublished canvasBuffer.canvas.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBgPublished canvasBuffer.canvas.patternBg option. | PatternOptions | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.blendModePublished canvasBuffer.canvas.patternBg.blendMode option. | GlobalCompositeOperation | OptionalDefault— | 26 values"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor" | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.colorPublished canvasBuffer.canvas.patternBg.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.customPatternImagePublished canvasBuffer.canvas.patternBg.customPatternImage option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradientPublished canvasBuffer.canvas.patternBg.gradient option. | GradientConfig | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.anglePublished canvasBuffer.canvas.patternBg.gradient.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.centerXPublished canvasBuffer.canvas.patternBg.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.centerYPublished canvasBuffer.canvas.patternBg.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.colorsPublished canvasBuffer.canvas.patternBg.gradient.colors option. | { stop: number; color: string; }[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.colors.colorPublished canvasBuffer.canvas.patternBg.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.colors.stopPublished canvasBuffer.canvas.patternBg.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.endRadiusPublished canvasBuffer.canvas.patternBg.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.endXPublished canvasBuffer.canvas.patternBg.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.endYPublished canvasBuffer.canvas.patternBg.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.repeatPublished canvasBuffer.canvas.patternBg.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.startAnglePublished canvasBuffer.canvas.patternBg.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.startRadiusPublished canvasBuffer.canvas.patternBg.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.startXPublished canvasBuffer.canvas.patternBg.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.startYPublished canvasBuffer.canvas.patternBg.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.gradient.typePublished canvasBuffer.canvas.patternBg.gradient.type option. | "linear" | "radial" | "conic" | RequiredDefaultRequired | "linear" "radial" "conic" | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.offsetXPublished canvasBuffer.canvas.patternBg.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.offsetYPublished canvasBuffer.canvas.patternBg.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.opacityPublished canvasBuffer.canvas.patternBg.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.repeatPublished canvasBuffer.canvas.patternBg.repeat option. | "repeat" | "no-repeat" | "repeat-x" | "repeat-y" | OptionalDefault— | "repeat" "no-repeat" "repeat-x" "repeat-y" | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.rotationPublished canvasBuffer.canvas.patternBg.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.scalePublished canvasBuffer.canvas.patternBg.scale option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.secondaryColorPublished canvasBuffer.canvas.patternBg.secondaryColor option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.sizePublished canvasBuffer.canvas.patternBg.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.spacingPublished canvasBuffer.canvas.patternBg.spacing option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.patternBg.typePublished canvasBuffer.canvas.patternBg.type option. | "grid" | "dots" | "diagonal" | "stripes" | "waves" | "crosses" | "hexagons" | "checkerboard" | "diamonds" | "triangles" | "stars" | "polka" | "custom" | RequiredDefaultRequired | 13 values"grid" "dots" "diagonal" "stripes" "waves" "crosses" "hexagons" "checkerboard" "diamonds" "triangles" "stars" "polka" "custom" | node22 · node24 · node26 |
canvasBuffer.canvas.rotationPublished canvasBuffer.canvas.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadowPublished canvasBuffer.canvas.shadow option. | ShadowOptions | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.blurPublished canvasBuffer.canvas.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.borderPositionPublished canvasBuffer.canvas.shadow.borderPosition option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.borderRadiusPublished canvasBuffer.canvas.shadow.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.colorPublished canvasBuffer.canvas.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradientPublished canvasBuffer.canvas.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.colorsPublished canvasBuffer.canvas.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.colors.colorPublished canvasBuffer.canvas.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.colors.stopPublished canvasBuffer.canvas.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.endXPublished canvasBuffer.canvas.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.endYPublished canvasBuffer.canvas.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.pivotXPublished canvasBuffer.canvas.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.pivotYPublished canvasBuffer.canvas.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.repeatPublished canvasBuffer.canvas.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.rotatePublished canvasBuffer.canvas.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.startXPublished canvasBuffer.canvas.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.startYPublished canvasBuffer.canvas.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.typePublished canvasBuffer.canvas.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.endRadiusPublished canvasBuffer.canvas.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.startRadiusPublished canvasBuffer.canvas.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.centerXPublished canvasBuffer.canvas.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.centerYPublished canvasBuffer.canvas.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.gradient.startAnglePublished canvasBuffer.canvas.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.offsetXPublished canvasBuffer.canvas.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.offsetYPublished canvasBuffer.canvas.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.opacityPublished canvasBuffer.canvas.shadow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.shadow.roundedCornersPublished canvasBuffer.canvas.shadow.roundedCorners option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.strokePublished canvasBuffer.canvas.stroke option. | StrokeOptions | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.blurPublished canvasBuffer.canvas.stroke.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.borderPositionPublished canvasBuffer.canvas.stroke.borderPosition option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.borderRadiusPublished canvasBuffer.canvas.stroke.borderRadius option. | number | "circular" | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.colorPublished canvasBuffer.canvas.stroke.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradientPublished canvasBuffer.canvas.stroke.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.colorsPublished canvasBuffer.canvas.stroke.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.colors.colorPublished canvasBuffer.canvas.stroke.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.colors.stopPublished canvasBuffer.canvas.stroke.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.endXPublished canvasBuffer.canvas.stroke.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.endYPublished canvasBuffer.canvas.stroke.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.pivotXPublished canvasBuffer.canvas.stroke.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.pivotYPublished canvasBuffer.canvas.stroke.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.repeatPublished canvasBuffer.canvas.stroke.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.rotatePublished canvasBuffer.canvas.stroke.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.startXPublished canvasBuffer.canvas.stroke.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.startYPublished canvasBuffer.canvas.stroke.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.typePublished canvasBuffer.canvas.stroke.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.endRadiusPublished canvasBuffer.canvas.stroke.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.startRadiusPublished canvasBuffer.canvas.stroke.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.centerXPublished canvasBuffer.canvas.stroke.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.centerYPublished canvasBuffer.canvas.stroke.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.gradient.startAnglePublished canvasBuffer.canvas.stroke.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.opacityPublished canvasBuffer.canvas.stroke.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.positionPublished canvasBuffer.canvas.stroke.position option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.roundedCornersPublished canvasBuffer.canvas.stroke.roundedCorners option. | string | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.stylePublished canvasBuffer.canvas.stroke.style option. | "solid" | "dashed" | "dotted" | "groove" | "ridge" | "double" | OptionalDefault— | 6 values"solid" "dashed" "dotted" "groove" "ridge" "double" | node22 · node24 · node26 |
canvasBuffer.canvas.stroke.widthPublished canvasBuffer.canvas.stroke.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.transparentBasePublished canvasBuffer.canvas.transparentBase option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
canvasBuffer.canvas.videoBgPublished canvasBuffer.canvas.videoBg option. | CanvasVideoBackground | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.alignPlacement used by `contain` / `cover` when `inherit` is false. | AlignMode | OptionalDefault— | 9 values"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.autoplayPublished canvasBuffer.canvas.videoBg.autoplay option.Deprecated | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filtersImage filters applied to this background only. | ImageFilter[] | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.anglePublished canvasBuffer.canvas.videoBg.filters.angle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.centerXPublished canvasBuffer.canvas.videoBg.filters.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.centerYPublished canvasBuffer.canvas.videoBg.filters.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.heightPublished canvasBuffer.canvas.videoBg.filters.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.intensityPublished canvasBuffer.canvas.videoBg.filters.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.levelsPublished canvasBuffer.canvas.videoBg.filters.levels option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.radiusPublished canvasBuffer.canvas.videoBg.filters.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.sizePublished canvasBuffer.canvas.videoBg.filters.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.typePublished canvasBuffer.canvas.videoBg.filters.type option. | "saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize" | RequiredDefaultRequired | 17 values"saturation" "gaussianBlur" "motionBlur" "radialBlur" "sharpen" "noise" "grain" "edgeDetection" "emboss" "invert" "grayscale" "sepia" "pixelate" "brightness" "contrast" "hueShift" "posterize" | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.valuePublished canvasBuffer.canvas.videoBg.filters.value option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.widthPublished canvasBuffer.canvas.videoBg.filters.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.xOptional pixelate region. Omit for the whole filtered surface. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.filters.yPublished canvasBuffer.canvas.videoBg.filters.y option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.fitResize policy when `inherit` is false. | FitMode | OptionalDefault— | "fill" "contain" "cover" | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.formatPublished canvasBuffer.canvas.videoBg.format option. | "jpg" | "png" | OptionalDefault— | "jpg" "png" | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.frame1-based frame number. Mutually exclusive with `time`. Defaults to frame 1 when neither selector is provided. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.inheritAdopt the source image dimensions as the canvas dimensions. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.loopPublished canvasBuffer.canvas.videoBg.loop option.Deprecated | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.opacityBackground-image opacity, multiplied by the canvas-level opacity. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.qualityFFmpeg image quality value from 1 (best) through 31. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.sourcePublished canvasBuffer.canvas.videoBg.source option. | string | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
canvasBuffer.canvas.videoBg.timeTimestamp in seconds. Mutually exclusive with `frame`. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.widthPublished canvasBuffer.canvas.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.xPublished canvasBuffer.canvas.x option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.yPublished canvasBuffer.canvas.y option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.zoomPublished canvasBuffer.canvas.zoom option. | { scale?: number; centerX?: number; centerY?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.zoom.centerXPublished canvasBuffer.canvas.zoom.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.zoom.centerYPublished canvasBuffer.canvas.zoom.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
canvasBuffer.canvas.zoom.scalePublished canvasBuffer.canvas.zoom.scale option. | number | OptionalDefault— | — | node22 · node24 · node26 |
| painterOpts | ||||
painterOpts.resolveAssetRefsWhen **true**, string leaves in the payload are resolved via {@link AssetManager.resolve } (same rules as {@link ApexPainter.prepareForRender } / {@link ApexPainter.renderScene }). | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
textArray.bold
OptionalPublished textArray.bold option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
textArray.color
OptionalPublished textArray.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.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
textArray.decorations.bold
OptionalPublished textArray.decorations.bold option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
textArray.decorations.italic
OptionalPublished textArray.decorations.italic option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
textArray.decorations.overline
OptionalPublished textArray.decorations.overline option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.overline.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.overline.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.overline.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.overline.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.overline.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.overline.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.overline.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.overline.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.overline.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.overline.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published textArray.decorations.overline.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.overline.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.overline.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.overline.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published textArray.decorations.overline.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.overline.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.overline.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.overline.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.overline.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.overline.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.strikethrough.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.decorations.underline
OptionalPublished textArray.decorations.underline option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.underline.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.underline.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.underline.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.underline.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.underline.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.underline.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.underline.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.underline.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.underline.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.underline.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published textArray.decorations.underline.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.underline.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.underline.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.underline.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published textArray.decorations.underline.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.underline.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.underline.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.underline.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.underline.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.decorations.underline.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.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
textArray.effects.glow
OptionalPublished textArray.effects.glow option.
- Type
TextGlowStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.effects.glow.color
OptionalPublished textArray.effects.glow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.effects.glow.gradient
OptionalPublished textArray.effects.glow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.glow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.glow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.glow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.glow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.glow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.glow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.glow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.glow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published textArray.effects.glow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.glow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.glow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.glow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published textArray.effects.glow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.glow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.glow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.glow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.glow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.effects.glow.intensity
OptionalPublished textArray.effects.glow.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.effects.glow.opacity
OptionalPublished textArray.effects.glow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.effects.highlight
OptionalPublished textArray.effects.highlight option.
- Type
TextHighlightStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.highlight.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.highlight.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.highlight.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.highlight.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.highlight.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.highlight.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.highlight.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.highlight.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.highlight.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.highlight.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published textArray.effects.highlight.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.highlight.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.highlight.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.highlight.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published textArray.effects.highlight.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.highlight.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.highlight.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.highlight.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.highlight.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.highlight.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.effects.shadow
OptionalPublished textArray.effects.shadow option.
- Type
TextShadowStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.effects.shadow.blur
OptionalPublished textArray.effects.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.effects.shadow.color
OptionalPublished textArray.effects.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published textArray.effects.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published textArray.effects.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.effects.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.effects.shadow.offsetX
OptionalPublished textArray.effects.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.effects.shadow.offsetY
OptionalPublished textArray.effects.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.effects.shadow.opacity
OptionalPublished textArray.effects.shadow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.fill
OptionalGrouped fill color / gradient and draw opacity (see {@link resolveTextFill}).
- Type
TextFill- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.fill.color
OptionalPublished textArray.fill.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.fill.gradient
OptionalPublished textArray.fill.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.fill.gradient.colors
RequiredPublished textArray.fill.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.fill.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.fill.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.fill.gradient.endX
OptionalPublished textArray.fill.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.fill.gradient.endY
OptionalPublished textArray.fill.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.fill.gradient.pivotX
OptionalPublished textArray.fill.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.fill.gradient.pivotY
OptionalPublished textArray.fill.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.fill.gradient.repeat
OptionalPublished textArray.fill.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
textArray.fill.gradient.rotate
OptionalPublished textArray.fill.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.fill.gradient.startX
OptionalPublished textArray.fill.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.fill.gradient.startY
OptionalPublished textArray.fill.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.fill.gradient.type
RequiredPublished textArray.fill.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published textArray.fill.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.fill.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.fill.gradient.centerX
OptionalPublished textArray.fill.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.fill.gradient.centerY
OptionalPublished textArray.fill.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.fill.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.fill.opacity
OptionalPublished textArray.fill.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.font
OptionalPublished textArray.font option.
- Type
{ size?: number; family?: string; name?: string; path?: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.font.family
OptionalPublished textArray.font.family option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.font.name
OptionalPublished textArray.font.name option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.font.path
OptionalPublished textArray.font.path option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.font.size
OptionalPublished textArray.font.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.fontFamily
OptionalPublished textArray.fontFamily option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.fontName
OptionalPublished textArray.fontName option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.fontPath
OptionalPublished textArray.fontPath option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.fontSize
OptionalPublished textArray.fontSize option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.glow
OptionalPublished textArray.glow option.
- Type
TextGlowStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.glow.color
OptionalPublished textArray.glow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.glow.gradient
OptionalPublished textArray.glow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.glow.gradient.colors
RequiredPublished textArray.glow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.glow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.glow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.glow.gradient.endX
OptionalPublished textArray.glow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.glow.gradient.endY
OptionalPublished textArray.glow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.glow.gradient.pivotX
OptionalPublished textArray.glow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.glow.gradient.pivotY
OptionalPublished textArray.glow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.glow.gradient.repeat
OptionalPublished textArray.glow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
textArray.glow.gradient.rotate
OptionalPublished textArray.glow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.glow.gradient.startX
OptionalPublished textArray.glow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.glow.gradient.startY
OptionalPublished textArray.glow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.glow.gradient.type
RequiredPublished textArray.glow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published textArray.glow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.glow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.glow.gradient.centerX
OptionalPublished textArray.glow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.glow.gradient.centerY
OptionalPublished textArray.glow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.glow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.glow.intensity
OptionalPublished textArray.glow.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.glow.opacity
OptionalPublished textArray.glow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.gradient
OptionalPublished textArray.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.gradient.colors
RequiredPublished textArray.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.gradient.colors.color
RequiredPublished textArray.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.gradient.colors.stop
RequiredPublished textArray.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.gradient.endX
OptionalPublished textArray.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.gradient.endY
OptionalPublished textArray.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.gradient.pivotX
OptionalPublished textArray.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.gradient.pivotY
OptionalPublished textArray.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.gradient.repeat
OptionalPublished textArray.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
textArray.gradient.rotate
OptionalPublished textArray.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.gradient.startX
OptionalPublished textArray.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.gradient.startY
OptionalPublished textArray.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.gradient.type
RequiredPublished textArray.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
textArray.gradient.endRadius
OptionalPublished textArray.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.gradient.startRadius
OptionalPublished textArray.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.gradient.centerX
OptionalPublished textArray.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.gradient.centerY
OptionalPublished textArray.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.gradient.startAngle
OptionalPublished textArray.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.highlight
OptionalPublished textArray.highlight option.
- Type
TextHighlightStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.highlight.color
OptionalPublished textArray.highlight.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.highlight.gradient
OptionalPublished textArray.highlight.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.highlight.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.highlight.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.highlight.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.highlight.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.highlight.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.highlight.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.highlight.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.highlight.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published textArray.highlight.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.highlight.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.highlight.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.highlight.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published textArray.highlight.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.highlight.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.highlight.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.highlight.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.highlight.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.highlight.opacity
OptionalPublished textArray.highlight.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.includeCharMetrics
OptionalPublished textArray.includeCharMetrics option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
textArray.italic
OptionalPublished textArray.italic option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
textArray.layout
OptionalGrouped line height, spacing, and wrap bounds (see {@link resolveTextLayout}).
- Type
TextLayout- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.layout.letterSpacing
OptionalPublished textArray.layout.letterSpacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.layout.lineHeight
OptionalPublished textArray.layout.lineHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.layout.maxHeight
OptionalPublished textArray.layout.maxHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.layout.maxWidth
OptionalPublished textArray.layout.maxWidth option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.layout.wordSpacing
OptionalPublished textArray.layout.wordSpacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.letterSpacing
OptionalPublished textArray.letterSpacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.lineHeight
OptionalPublished textArray.lineHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.maxHeight
OptionalPublished textArray.maxHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.maxWidth
OptionalPublished textArray.maxWidth option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.measurementCanvas
OptionalPublished textArray.measurementCanvas option.
- Type
{ width?: number; height?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.measurementCanvas.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.measurementCanvas.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.opacity
OptionalPublished textArray.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.overline
OptionalPublished textArray.overline option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.overline.color
OptionalPublished textArray.overline.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.overline.gradient
OptionalPublished textArray.overline.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.overline.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.overline.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.overline.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.overline.gradient.endX
OptionalPublished textArray.overline.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.overline.gradient.endY
OptionalPublished textArray.overline.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.overline.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.overline.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.overline.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published textArray.overline.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.overline.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.overline.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.overline.gradient.type
RequiredPublished textArray.overline.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published textArray.overline.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.overline.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.overline.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.overline.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.overline.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.overline.width
OptionalPublished textArray.overline.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.placement
OptionalGrouped alignment, baseline, and rotation (see {@link resolveTextPlacement}).
- Type
TextPlacement- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.placement.rotation
OptionalPublished textArray.placement.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.placement.textAlign
OptionalPublished textArray.placement.textAlign option.
- Type
TextAlignMode- Default
- —
- Allowed
5 values
"center""left""right""start""end"- Runtime
- node22, node24, node26
textArray.placement.textBaseline
OptionalPublished textArray.placement.textBaseline option.
- Type
TextBaselineMode- Default
- —
- Allowed
6 values
"top""bottom""alphabetic""hanging""ideographic""middle"- Runtime
- node22, node24, node26
textArray.rotation
OptionalPublished textArray.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.shadow
OptionalPublished textArray.shadow option.
- Type
TextShadowStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.shadow.blur
OptionalPublished textArray.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.shadow.color
OptionalPublished textArray.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.shadow.gradient
OptionalPublished textArray.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.shadow.gradient.colors
RequiredPublished textArray.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.shadow.gradient.endX
OptionalPublished textArray.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.shadow.gradient.endY
OptionalPublished textArray.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.shadow.gradient.pivotX
OptionalPublished textArray.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.shadow.gradient.pivotY
OptionalPublished textArray.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.shadow.gradient.repeat
OptionalPublished textArray.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
textArray.shadow.gradient.rotate
OptionalPublished textArray.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.shadow.gradient.startX
OptionalPublished textArray.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.shadow.gradient.startY
OptionalPublished textArray.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.shadow.gradient.type
RequiredPublished textArray.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published textArray.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.shadow.offsetX
OptionalPublished textArray.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.shadow.offsetY
OptionalPublished textArray.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.shadow.opacity
OptionalPublished textArray.shadow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.strikethrough
OptionalPublished textArray.strikethrough option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.strikethrough.color
OptionalPublished textArray.strikethrough.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.strikethrough.gradient
OptionalPublished textArray.strikethrough.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.strikethrough.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.strikethrough.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.strikethrough.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.strikethrough.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.strikethrough.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.strikethrough.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.strikethrough.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.strikethrough.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published textArray.strikethrough.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.strikethrough.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.strikethrough.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.strikethrough.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published textArray.strikethrough.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.strikethrough.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.strikethrough.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.strikethrough.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.strikethrough.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.strikethrough.width
OptionalPublished textArray.strikethrough.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.stroke
OptionalPublished textArray.stroke option.
- Type
TextStrokeStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.stroke.color
OptionalPublished textArray.stroke.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.stroke.gradient
OptionalPublished textArray.stroke.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.stroke.gradient.colors
RequiredPublished textArray.stroke.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.stroke.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.stroke.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.stroke.gradient.endX
OptionalPublished textArray.stroke.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.stroke.gradient.endY
OptionalPublished textArray.stroke.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.stroke.gradient.pivotX
OptionalPublished textArray.stroke.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.stroke.gradient.pivotY
OptionalPublished textArray.stroke.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.stroke.gradient.repeat
OptionalPublished textArray.stroke.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
textArray.stroke.gradient.rotate
OptionalPublished textArray.stroke.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.stroke.gradient.startX
OptionalPublished textArray.stroke.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.stroke.gradient.startY
OptionalPublished textArray.stroke.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.stroke.gradient.type
RequiredPublished textArray.stroke.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published textArray.stroke.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.stroke.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.stroke.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.stroke.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.stroke.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.stroke.opacity
OptionalPublished textArray.stroke.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.stroke.style
OptionalPublished textArray.stroke.style option.
- Type
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"- Default
- —
- Allowed
6 values
"solid""dashed""dotted""groove""ridge""double"- Runtime
- node22, node24, node26
textArray.stroke.width
OptionalPublished textArray.stroke.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.text
RequiredPublished textArray.text option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.textAlign
OptionalPublished textArray.textAlign option.
- Type
TextAlignMode- Default
- —
- Allowed
5 values
"center""left""right""start""end"- Runtime
- node22, node24, node26
textArray.textBaseline
OptionalPublished textArray.textBaseline option.
- Type
TextBaselineMode- Default
- —
- Allowed
6 values
"top""bottom""alphabetic""hanging""ideographic""middle"- Runtime
- node22, node24, node26
textArray.textOnCurve
OptionalPublished textArray.textOnCurve option.
- Type
TextCurveConfig- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.textOnCurve.baselineOffset option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.textOnCurve.layoutMode
OptionalPublished textArray.textOnCurve.layoutMode option.
- Type
CurvedTextLayoutMode- Default
- —
- Allowed
"fit""clamp""override"- Runtime
- node22, node24, node26
textArray.textOnCurve.radius
OptionalPublished textArray.textOnCurve.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.textOnCurve.startAngleDeg option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.textOnCurve.sweepAngle
RequiredPublished textArray.textOnCurve.sweepAngle option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.textOnCurve.up
OptionalPublished textArray.textOnCurve.up option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
textArray.underline
OptionalPublished textArray.underline option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.underline.color
OptionalPublished textArray.underline.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.underline.gradient
OptionalPublished textArray.underline.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.underline.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.underline.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.underline.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.underline.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.underline.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.underline.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.underline.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.underline.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published textArray.underline.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.underline.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.underline.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.underline.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published textArray.underline.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.underline.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.underline.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.underline.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published textArray.underline.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.underline.width
OptionalPublished textArray.underline.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.wordSpacing
OptionalPublished textArray.wordSpacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.x
RequiredPublished textArray.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
textArray.y
RequiredPublished textArray.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.buffer
RequiredPublished canvasBuffer.buffer option.
- Type
Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas
RequiredPublished canvasBuffer.canvas option.
- Type
CanvasConfig- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.bgLayers
OptionalPublished canvasBuffer.canvas.bgLayers option.
- Type
BackgroundLayer[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.blendMode option.
- Type
GlobalCompositeOperation- Default
- —
- Allowed
26 values
"color""color-burn""color-dodge""copy""darken""destination-atop""destination-in""destination-out""destination-over""difference""exclusion""hard-light""hue""lighten""lighter""luminosity""multiply""overlay""saturation""screen""soft-light""source-atop""source-in""source-out""source-over""xor"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.type option.
- Type
"color"- Default
- Required
- Allowed
"color"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.value option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.align option.
- Type
AlignMode- Default
- —
- Allowed
9 values
"center""top""bottom""left""right""top-left""top-right""bottom-left""bottom-right"- Runtime
- node22, node24, node26
canvasBuffer.canvas.bgLayers.fit
OptionalPublished canvasBuffer.canvas.bgLayers.fit option.
- Type
"fill" | "contain" | "cover"- Default
- —
- Allowed
"fill""contain""cover"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.source option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.repeat option.
- Type
BackgroundPatternRepeat- Default
- —
- Allowed
"repeat""no-repeat""repeat-x""repeat-y"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern option.
- Type
PatternOptions- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.blendMode option.
- Type
GlobalCompositeOperation- Default
- —
- Allowed
26 values
"color""color-burn""color-dodge""copy""darken""destination-atop""destination-in""destination-out""destination-over""difference""exclusion""hard-light""hue""lighten""lighter""luminosity""multiply""overlay""saturation""screen""soft-light""source-atop""source-in""source-out""source-over""xor"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.customPatternImage option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient option.
- Type
GradientConfig- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.colors option.
- Type
{ stop: number; color: string; }[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.gradient.type option.
- Type
"linear" | "radial" | "conic"- Default
- Required
- Allowed
"linear""radial""conic"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.repeat option.
- Type
"repeat" | "no-repeat" | "repeat-x" | "repeat-y"- Default
- —
- Allowed
"repeat""no-repeat""repeat-x""repeat-y"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.scale option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.secondaryColor option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.spacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.pattern.type option.
- Type
"grid" | "dots" | "diagonal" | "stripes" | "waves" | "crosses" | "hexagons" | "checkerboard" | "diamonds" | "triangles" | "stars" | "polka" | "custom"- Default
- Required
- Allowed
13 values
"grid""dots""diagonal""stripes""waves""crosses""hexagons""checkerboard""diamonds""triangles""stars""polka""custom"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.bgLayers.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.blendMode
OptionalPublished canvasBuffer.canvas.blendMode option.
- Type
GlobalCompositeOperation- Default
- —
- Allowed
26 values
"color""color-burn""color-dodge""copy""darken""destination-atop""destination-in""destination-out""destination-over""difference""exclusion""hard-light""hue""lighten""lighter""luminosity""multiply""overlay""saturation""screen""soft-light""source-atop""source-in""source-out""source-over""xor"- Runtime
- node22, node24, node26
canvasBuffer.canvas.blur
OptionalPublished canvasBuffer.canvas.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.borderRadius
OptionalPublished canvasBuffer.canvas.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.colorBg
OptionalPublished canvasBuffer.canvas.colorBg option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.customBg
OptionalPublished canvasBuffer.canvas.customBg option.
- Type
CanvasCustomBackground- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Placement used by `contain` / `cover` when `inherit` is false.
- Type
AlignMode- Default
- —
- Allowed
9 values
"center""top""bottom""left""right""top-left""top-right""bottom-left""bottom-right"- Runtime
- node22, node24, node26
Image filters applied to this background only.
- Type
ImageFilter[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.levels option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.type option.
- Type
"saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize"- Default
- Required
- Allowed
17 values
"saturation""gaussianBlur""motionBlur""radialBlur""sharpen""noise""grain""edgeDetection""emboss""invert""grayscale""sepia""pixelate""brightness""contrast""hueShift""posterize"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.value option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Optional pixelate region. Omit for the whole filtered surface.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.filters.y option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.customBg.fit
OptionalResize policy when `inherit` is false.
- Type
FitMode- Default
- —
- Allowed
"fill""contain""cover"- Runtime
- node22, node24, node26
Adopt the source image dimensions as the canvas dimensions.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Background-image opacity, multiplied by the canvas-level opacity.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.customBg.source option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.gradientBg
OptionalPublished canvasBuffer.canvas.gradientBg option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.gradientBg.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.height
OptionalPublished canvasBuffer.canvas.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.noiseBg
OptionalPublished canvasBuffer.canvas.noiseBg option.
- Type
{ intensity?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.noiseBg.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.opacity
OptionalPublished canvasBuffer.canvas.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.patternBg
OptionalPublished canvasBuffer.canvas.patternBg option.
- Type
PatternOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.blendMode option.
- Type
GlobalCompositeOperation- Default
- —
- Allowed
26 values
"color""color-burn""color-dodge""copy""darken""destination-atop""destination-in""destination-out""destination-over""difference""exclusion""hard-light""hue""lighten""lighter""luminosity""multiply""overlay""saturation""screen""soft-light""source-atop""source-in""source-out""source-over""xor"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.customPatternImage option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient option.
- Type
GradientConfig- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.colors option.
- Type
{ stop: number; color: string; }[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.gradient.type option.
- Type
"linear" | "radial" | "conic"- Default
- Required
- Allowed
"linear""radial""conic"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.repeat option.
- Type
"repeat" | "no-repeat" | "repeat-x" | "repeat-y"- Default
- —
- Allowed
"repeat""no-repeat""repeat-x""repeat-y"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.scale option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.secondaryColor option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.spacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.patternBg.type option.
- Type
"grid" | "dots" | "diagonal" | "stripes" | "waves" | "crosses" | "hexagons" | "checkerboard" | "diamonds" | "triangles" | "stars" | "polka" | "custom"- Default
- Required
- Allowed
13 values
"grid""dots""diagonal""stripes""waves""crosses""hexagons""checkerboard""diamonds""triangles""stars""polka""custom"- Runtime
- node22, node24, node26
canvasBuffer.canvas.rotation
OptionalPublished canvasBuffer.canvas.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.shadow
OptionalPublished canvasBuffer.canvas.shadow option.
- Type
ShadowOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.shadow.blur
OptionalPublished canvasBuffer.canvas.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.shadow.color
OptionalPublished canvasBuffer.canvas.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.shadow.roundedCorners option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.stroke
OptionalPublished canvasBuffer.canvas.stroke option.
- Type
StrokeOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.stroke.blur
OptionalPublished canvasBuffer.canvas.stroke.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.borderPosition option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.borderRadius option.
- Type
number | "circular"- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.stroke.color
OptionalPublished canvasBuffer.canvas.stroke.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.position option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.stroke.roundedCorners option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.stroke.style
OptionalPublished canvasBuffer.canvas.stroke.style option.
- Type
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"- Default
- —
- Allowed
6 values
"solid""dashed""dotted""groove""ridge""double"- Runtime
- node22, node24, node26
canvasBuffer.canvas.stroke.width
OptionalPublished canvasBuffer.canvas.stroke.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.transparentBase option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
canvasBuffer.canvas.videoBg
OptionalPublished canvasBuffer.canvas.videoBg option.
- Type
CanvasVideoBackground- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Placement used by `contain` / `cover` when `inherit` is false.
- Type
AlignMode- Default
- —
- Allowed
9 values
"center""top""bottom""left""right""top-left""top-right""bottom-left""bottom-right"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.autoplay option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Image filters applied to this background only.
- Type
ImageFilter[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.angle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.levels option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.type option.
- Type
"saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize"- Default
- Required
- Allowed
17 values
"saturation""gaussianBlur""motionBlur""radialBlur""sharpen""noise""grain""edgeDetection""emboss""invert""grayscale""sepia""pixelate""brightness""contrast""hueShift""posterize"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.value option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Optional pixelate region. Omit for the whole filtered surface.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.filters.y option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.videoBg.fit
OptionalResize policy when `inherit` is false.
- Type
FitMode- Default
- —
- Allowed
"fill""contain""cover"- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.format option.
- Type
"jpg" | "png"- Default
- —
- Allowed
"jpg""png"- Runtime
- node22, node24, node26
1-based frame number. Mutually exclusive with `time`. Defaults to frame 1 when neither selector is provided.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Adopt the source image dimensions as the canvas dimensions.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
canvasBuffer.canvas.videoBg.loop
OptionalPublished canvasBuffer.canvas.videoBg.loop option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Background-image opacity, multiplied by the canvas-level opacity.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
FFmpeg image quality value from 1 (best) through 31.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published canvasBuffer.canvas.videoBg.source option.
- Type
string | Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.videoBg.time
OptionalTimestamp in seconds. Mutually exclusive with `frame`.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.width
OptionalPublished canvasBuffer.canvas.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.x
OptionalPublished canvasBuffer.canvas.x option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.y
OptionalPublished canvasBuffer.canvas.y option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.zoom
OptionalPublished canvasBuffer.canvas.zoom option.
- Type
{ scale?: number; centerX?: number; centerY?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.zoom.centerX
OptionalPublished canvasBuffer.canvas.zoom.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.zoom.centerY
OptionalPublished canvasBuffer.canvas.zoom.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
canvasBuffer.canvas.zoom.scale
OptionalPublished canvasBuffer.canvas.zoom.scale option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
painterOpts.resolveAssetRefs
OptionalWhen **true**, string leaves in the payload are resolved via {@link AssetManager.resolve } (same rules as {@link ApexPainter.prepareForRender } / {@link ApexPainter.renderScene }).
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Types
TextProperties | TextProperties[]
- variant 1
TextProperties: TextProperties- text
string - x
number - y
number - font?
__type: { size?: number; family?: string; name?: string; path?: string; }- size?
number - family?
string - name?
string - path?
string
- size?
- fontSize?
number - fontFamily?
string - fontName?
string - fontPath?
string - bold?
boolean - italic?
boolean - decorations?
TextDecorations: TextDecorations- underline?
TextLineDecoration- variant 1
false - variant 2
true - variant 3
__type: { color?: string; gradient?: gradient; width?: number; }- color?
string - gradient?
gradient - width?
number
- color?
- variant 1
- overline?
TextLineDecoration- variant 1
false - variant 2
true - variant 3
__type: { color?: string; gradient?: gradient; width?: number; }- color?
string - gradient?
gradient - width?
number
- color?
- variant 1
- strikethrough?
TextLineDecoration- variant 1
false - variant 2
true - variant 3
__type: { color?: string; gradient?: gradient; width?: number; }- color?
string - gradient?
gradient - width?
number
- color?
- variant 1
- bold?
boolean - italic?
boolean
- underline?
- effects?
TextEffects: TextEffects- highlight?
TextHighlightStyle: TextHighlightStyle- color?
string - gradient?
gradient- variant 1
{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 2
{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 3
{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
- variant 1
- opacity?
number
- color?
- glow?
TextGlowStyle: TextGlowStyle- color?
string - gradient?
gradient- variant 1
{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 2
{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 3
{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
- variant 1
- intensity?
number - opacity?
number
- color?
- shadow?
TextShadowStyle: TextShadowStyle- color?
string - gradient?
gradient- variant 1
{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 2
{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 3
{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
- variant 1
- offsetX?
number - offsetY?
number - blur?
number - opacity?
number
- color?
- highlight?
- underline?
TextLineDecoration- variant 1
false - variant 2
true - variant 3
__type: { color?: string; gradient?: gradient; width?: number; }- color?
string - gradient?
gradient- variant 1
{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 2
{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 3
{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
- variant 1
- width?
number
- color?
- variant 1
- overline?
TextLineDecoration- variant 1
false - variant 2
true - variant 3
__type: { color?: string; gradient?: gradient; width?: number; }- color?
string - gradient?
gradient- variant 1
{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 2
{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 3
{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
- variant 1
- width?
number
- color?
- variant 1
- strikethrough?
TextLineDecoration- variant 1
false - variant 2
true - variant 3
__type: { color?: string; gradient?: gradient; width?: number; }- color?
string - gradient?
gradient- variant 1
{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 2
{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 3
{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
- variant 1
- width?
number
- color?
- variant 1
- highlight?
TextHighlightStyle: TextHighlightStyle- 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
- opacity?
number
- color?
- glow?
TextGlowStyle: TextGlowStyle- 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
- intensity?
number - opacity?
number
- color?
- shadow?
TextShadowStyle: TextShadowStyle- 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
- color?
- layout?
TextLayout: TextLayout- lineHeight?
number - letterSpacing?
number - wordSpacing?
number - maxWidth?
number - maxHeight?
number
- lineHeight?
- placement?
TextPlacement: TextPlacement- textAlign?
TextAlignMode- variant 1
"center" - variant 2
"left" - variant 3
"right" - variant 4
"start" - variant 5
"end"
- variant 1
- textBaseline?
TextBaselineMode- variant 1
"top" - variant 2
"bottom" - variant 3
"alphabetic" - variant 4
"hanging" - variant 5
"ideographic" - variant 6
"middle"
- variant 1
- rotation?
number
- textAlign?
- fill?
TextFill: TextFill- 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
- opacity?
number
- color?
- lineHeight?
number - letterSpacing?
number - wordSpacing?
number - maxWidth?
number - maxHeight?
number - textAlign?
TextAlignMode- variant 1
"center" - variant 2
"left" - variant 3
"right" - variant 4
"start" - variant 5
"end"
- variant 1
- textBaseline?
TextBaselineMode- variant 1
"top" - variant 2
"bottom" - variant 3
"alphabetic" - variant 4
"hanging" - variant 5
"ideographic" - variant 6
"middle"
- variant 1
- rotation?
number - color?
string - gradient?
gradient- variant 1
__type: { type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"linear" - startX?
number - startY?
number - endX?
number - endY?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat"- variant 1
"repeat" - variant 2
"reflect" - variant 3
"no-repeat"
- 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
- opacity?
number - stroke?
TextStrokeStyle: TextStrokeStyle- color?
string - width?
number - 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
- opacity?
number - 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?
- textOnCurve?
TextCurveConfig: TextCurveConfig- sweepAngle
number - radius?
number - up?
boolean - layoutMode?
CurvedTextLayoutMode- variant 1
"fit" - variant 2
"clamp" - variant 3
"override"
- variant 1
- baselineOffset?
number - startAngleDeg?
number
- sweepAngle
- includeCharMetrics?
boolean - measurementCanvas?
__type: { width?: number; height?: number; }- width?
number - height?
number
- width?
- text
- variant 2
TextProperties[]- variant 1
TextProperties: TextProperties- text
string - x
number - y
number - font?
__type: { size?: number; family?: string; name?: string; path?: string; }- size?
number - family?
string - name?
string - path?
string
- size?
- fontSize?
number - fontFamily?
string - fontName?
string - fontPath?
string - bold?
boolean - italic?
boolean - decorations?
TextDecorations: TextDecorations- underline?
TextLineDecoration- variant 1
false - variant 2
true - variant 3
{ color?: string; gradient?: gradient; width?: number; }
- variant 1
- overline?
TextLineDecoration- variant 1
false - variant 2
true - variant 3
{ color?: string; gradient?: gradient; width?: number; }
- variant 1
- strikethrough?
TextLineDecoration- variant 1
false - variant 2
true - variant 3
{ color?: string; gradient?: gradient; width?: number; }
- variant 1
- bold?
boolean - italic?
boolean
- underline?
- effects?
TextEffects: TextEffects- highlight?
TextHighlightStyle: TextHighlightStyle- color?
string - gradient?
gradient - opacity?
number
- color?
- glow?
TextGlowStyle: TextGlowStyle- color?
string - gradient?
gradient - intensity?
number - opacity?
number
- color?
- shadow?
TextShadowStyle: TextShadowStyle- color?
string - gradient?
gradient - offsetX?
number - offsetY?
number - blur?
number - opacity?
number
- color?
- highlight?
- underline?
TextLineDecoration- variant 1
false - variant 2
true - variant 3
__type: { color?: string; gradient?: gradient; width?: number; }- color?
string - gradient?
gradient - width?
number
- color?
- variant 1
- overline?
TextLineDecoration- variant 1
false - variant 2
true - variant 3
__type: { color?: string; gradient?: gradient; width?: number; }- color?
string - gradient?
gradient - width?
number
- color?
- variant 1
- strikethrough?
TextLineDecoration- variant 1
false - variant 2
true - variant 3
__type: { color?: string; gradient?: gradient; width?: number; }- color?
string - gradient?
gradient - width?
number
- color?
- variant 1
- highlight?
TextHighlightStyle: TextHighlightStyle- color?
string - gradient?
gradient- variant 1
{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 2
{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 3
{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
- variant 1
- opacity?
number
- color?
- glow?
TextGlowStyle: TextGlowStyle- color?
string - gradient?
gradient- variant 1
{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 2
{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 3
{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
- variant 1
- intensity?
number - opacity?
number
- color?
- shadow?
TextShadowStyle: TextShadowStyle- color?
string - gradient?
gradient- variant 1
{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 2
{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 3
{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
- variant 1
- offsetX?
number - offsetY?
number - blur?
number - opacity?
number
- color?
- layout?
TextLayout: TextLayout- lineHeight?
number - letterSpacing?
number - wordSpacing?
number - maxWidth?
number - maxHeight?
number
- lineHeight?
- placement?
TextPlacement: TextPlacement- textAlign?
TextAlignMode- variant 1
"center" - variant 2
"left" - variant 3
"right" - variant 4
"start" - variant 5
"end"
- variant 1
- textBaseline?
TextBaselineMode- variant 1
"top" - variant 2
"bottom" - variant 3
"alphabetic" - variant 4
"hanging" - variant 5
"ideographic" - variant 6
"middle"
- variant 1
- rotation?
number
- textAlign?
- fill?
TextFill: TextFill- color?
string - gradient?
gradient- variant 1
{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 2
{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 3
{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
- variant 1
- opacity?
number
- color?
- lineHeight?
number - letterSpacing?
number - wordSpacing?
number - maxWidth?
number - maxHeight?
number - textAlign?
TextAlignMode- variant 1
"center" - variant 2
"left" - variant 3
"right" - variant 4
"start" - variant 5
"end"
- variant 1
- textBaseline?
TextBaselineMode- variant 1
"top" - variant 2
"bottom" - variant 3
"alphabetic" - variant 4
"hanging" - variant 5
"ideographic" - variant 6
"middle"
- variant 1
- rotation?
number - 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
- opacity?
number - stroke?
TextStrokeStyle: TextStrokeStyle- color?
string - width?
number - gradient?
gradient- variant 1
{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 2
{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 3
{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
- variant 1
- opacity?
number - 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?
- textOnCurve?
TextCurveConfig: TextCurveConfig- sweepAngle
number - radius?
number - up?
boolean - layoutMode?
CurvedTextLayoutMode- variant 1
"fit" - variant 2
"clamp" - variant 3
"override"
- variant 1
- baselineOffset?
number - startAngleDeg?
number
- sweepAngle
- includeCharMetrics?
boolean - measurementCanvas?
__type: { width?: number; height?: number; }- width?
number - height?
number
- width?
- text
- variant 1
Buffer<ArrayBufferLike> | CanvasResults
- variant 1
Buffer<ArrayBufferLike> - variant 2
CanvasResults: CanvasResults- buffer
Buffer<ArrayBufferLike> - canvas
CanvasConfig: CanvasConfig- width?
number - height?
number - x?
number - y?
number - customBg?
CanvasCustomBackground: CanvasCustomBackground- source
string - inherit?
boolean - fit?
FitMode- variant 1
"fill" - variant 2
"contain" - variant 3
"cover"
- variant 1
- align?
AlignMode- variant 1
"center" - variant 2
"top" - variant 3
"bottom" - variant 4
"left" - variant 5
"right" - variant 6
"top-left" - variant 7
"top-right" - variant 8
"bottom-left" - variant 9
"bottom-right"
- variant 1
- filters?
ImageFilter[]- variant 1
ImageFilter
- variant 1
- opacity?
number
- source
- videoBg?
CanvasVideoBackground: CanvasVideoBackground- source
string | Buffer<ArrayBufferLike>- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- frame?
number - time?
number - format?
"jpg" | "png"- variant 1
"jpg" - variant 2
"png"
- variant 1
- quality?
number - loop?
boolean - autoplay?
boolean - inherit?
boolean - fit?
FitMode- variant 1
"fill" - variant 2
"contain" - variant 3
"cover"
- variant 1
- align?
AlignMode- variant 1
"center" - variant 2
"top" - variant 3
"bottom" - variant 4
"left" - variant 5
"right" - variant 6
"top-left" - variant 7
"top-right" - variant 8
"bottom-left" - variant 9
"bottom-right"
- variant 1
- filters?
ImageFilter[]- variant 1
ImageFilter
- variant 1
- opacity?
number
- source
- colorBg?
string - gradientBg?
gradient- variant 1
__type: { type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"linear" - startX?
number - startY?
number - endX?
number - endY?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 2
__type: { type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }- type
"radial" - startX?
number - startY?
number - startRadius?
number - endX?
number - endY?
number - endRadius?
number - rotate?
number - pivotX?
number - pivotY?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
GradientStop[]
- type
- variant 3
__type: { type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }- type
"conic" - centerX?
number - centerY?
number - startAngle?
number - rotate?
number - pivotX?
number - pivotY?
number - colors
GradientStop[]
- type
- variant 1
- patternBg?
PatternOptions: PatternOptions- type
"grid" | "dots" | "diagonal" | "stripes" | "waves" | "crosses" | "hexagons" | "checkerboard" | "diamonds" | "triangles" | "stars" | "polka" | "custom"- variant 1
"grid" - variant 2
"dots" - variant 3
"diagonal" - variant 4
"stripes" - variant 5
"waves" - variant 6
"crosses" - variant 7
"hexagons" - variant 8
"checkerboard" - variant 9
"diamonds" - variant 10
"triangles" - variant 11
"stars" - variant 12
"polka" - variant 13
"custom"
- variant 1
- color?
string - secondaryColor?
string - opacity?
number - size?
number - spacing?
number - rotation?
number - customPatternImage?
string - repeat?
"repeat" | "no-repeat" | "repeat-x" | "repeat-y"- variant 1
"repeat" - variant 2
"no-repeat" - variant 3
"repeat-x" - variant 4
"repeat-y"
- variant 1
- scale?
number - offsetX?
number - offsetY?
number - blendMode?
GlobalCompositeOperation- variant 1
"color" - variant 2
"color-burn" - variant 3
"color-dodge" - variant 4
"copy" - variant 5
"darken" - variant 6
"destination-atop" - variant 7
"destination-in" - variant 8
"destination-out" - variant 9
"destination-over" - variant 10
"difference" - variant 11
"exclusion" - variant 12
"hard-light" - variant 13
"hue" - variant 14
"lighten" - variant 15
"lighter" - variant 16
"luminosity" - variant 17
"multiply" - variant 18
"overlay" - variant 19
"saturation" - variant 20
"screen" - variant 21
"soft-light" - variant 22
"source-atop" - variant 23
"source-in" - variant 24
"source-out" - variant 25
"source-over" - variant 26
"xor"
- variant 1
- gradient?
GradientConfig: GradientConfig- type
"linear" | "radial" | "conic" - startX?
number - startY?
number - endX?
number - endY?
number - startRadius?
number - endRadius?
number - angle?
number - centerX?
number - centerY?
number - startAngle?
number - repeat?
"repeat" | "reflect" | "no-repeat" - colors
{ stop: number; color: string; }[]
- type
- type
- noiseBg?
__type: { intensity?: number; }- intensity?
number
- intensity?
- transparentBase?
boolean - bgLayers?
BackgroundLayer[]- variant 1
BackgroundLayer- variant 1
{ type: "color"; value: string; opacity?: number; blendMode?: GlobalCompositeOperation; } - variant 2
{ type: "gradient"; value: gradient; opacity?: number; blendMode?: GlobalCompositeOperation; } - variant 3
{ type: "image"; source: string; opacity?: number; fit?: "fill" | "contain" | "cover"; align?: AlignMode; blendMode?: GlobalCompositeOperation; } - variant 4
{ type: "pattern"; source: string; repeat?: BackgroundPatternRepeat; opacity?: number; blendMode?: GlobalCompositeOperation; } - variant 5
{ type: "presetPattern"; pattern: PatternOptions; opacity?: number; blendMode?: GlobalCompositeOperation; } - variant 6
{ type: "noise"; intensity?: number; blendMode?: GlobalCompositeOperation; }
- variant 1
- variant 1
- blendMode?
GlobalCompositeOperation- variant 1
"color" - variant 2
"color-burn" - variant 3
"color-dodge" - variant 4
"copy" - variant 5
"darken" - variant 6
"destination-atop" - variant 7
"destination-in" - variant 8
"destination-out" - variant 9
"destination-over" - variant 10
"difference" - variant 11
"exclusion" - variant 12
"hard-light" - variant 13
"hue" - variant 14
"lighten" - variant 15
"lighter" - variant 16
"luminosity" - variant 17
"multiply" - variant 18
"overlay" - variant 19
"saturation" - variant 20
"screen" - variant 21
"soft-light" - variant 22
"source-atop" - variant 23
"source-in" - variant 24
"source-out" - variant 25
"source-over" - variant 26
"xor"
- variant 1
- opacity?
number - blur?
number - rotation?
number - borderRadius?
number | "circular"- variant 1
number - variant 2
"circular"
- variant 1
- borderPosition?
string - zoom?
__type: { scale?: number; centerX?: number; centerY?: number; }- scale?
number - centerX?
number - centerY?
number
- scale?
- stroke?
StrokeOptions: StrokeOptions- color?
string - gradient?
gradient- variant 1
{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 2
{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 3
{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
- variant 1
- width?
number - position?
number - blur?
number - opacity?
number - borderRadius?
number | "circular"- variant 1
number - variant 2
"circular"
- variant 1
- borderPosition?
string - roundedCorners?
string - style?
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"- variant 1
"solid" - variant 2
"dashed" - variant 3
"dotted" - variant 4
"groove" - variant 5
"ridge" - variant 6
"double"
- variant 1
- color?
- shadow?
ShadowOptions: ShadowOptions- color?
string - gradient?
gradient- variant 1
{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 2
{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; } - variant 3
{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
- variant 1
- offsetX?
number - offsetY?
number - blur?
number - opacity?
number - borderRadius?
number | "circular"- variant 1
number - variant 2
"circular"
- variant 1
- roundedCorners?
string - borderPosition?
string
- color?
- width?
- buffer
PainterAssetRefsOptions: PainterAssetRefsOptions
- resolveAssetRefs?
boolean
Return value
Promise<Buffer<ArrayBufferLike>>
The return contract is generated from the packed declaration. Async wrappers and nullable/undefined variants remain visible in the type model.
Errors
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.