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

ApexPainter member

ApexPainter.createGIF

Published ApexPainter.createGIF method.

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

Signature

TypeScript
(gifFrames: GIFInputFrame[] | undefined, options: GIFOptions, painterOpts?: PainterAssetRefsOptions) => Promise<Awaited<ReturnType<GIFCreator["createGIF"]>>>

Parameters

gifFrames

GIFInputFrame[]

Options

417 / 417 option paths
OptionTypeContractAllowed valuesRuntime & capabilities
gifFrames
gifFrames.backgroundExactly one of `buffer` or `background` is required.GIFFrameSourceOptionalDefault——node22 · node24 · node26
gifFrames.bufferExactly one of `buffer` or `background` is required.GIFFrameSourceOptionalDefault——node22 · node24 · node26
gifFrames.disposePublished gifFrames.dispose option.GIFDisposalMethodOptionalDefault—0 2 1 3node22 · node24 · node26
gifFrames.durationMilliseconds. If omitted, `GIFOptions.delay` (default 100ms) is used.numberOptionalDefault——node22 · node24 · node26
gifFrames.transparentColorPublished gifFrames.transparentColor option.string | numberOptionalDefault——node22 · node24 · node26
gifFrames.watermarkPublished gifFrames.watermark option.GIFWatermarkSpecOptionalDefault——node22 · node24 · node26
gifFrames.watermark.enablePublished gifFrames.watermark.enable option.booleanOptionalDefault—false truenode22 · node24 · node26
gifFrames.watermark.heightPublished gifFrames.watermark.height option.numberOptionalDefault——node22 · node24 · node26
gifFrames.watermark.marginPublished gifFrames.watermark.margin option.numberOptionalDefault——node22 · node24 · node26
gifFrames.watermark.opacityPublished gifFrames.watermark.opacity option.numberOptionalDefault——node22 · node24 · node26
gifFrames.watermark.positionPublished gifFrames.watermark.position option.GIFWatermarkPositionOptionalDefault—
5 values
"center" "top-left" "top-right" "bottom-left" "bottom-right"
node22 · node24 · node26
gifFrames.watermark.scalePublished gifFrames.watermark.scale option.numberOptionalDefault——node22 · node24 · node26
gifFrames.watermark.urlPublished gifFrames.watermark.url option.GIFFrameSourceRequiredDefaultRequired—node22 · node24 · node26
gifFrames.watermark.widthPublished gifFrames.watermark.width option.numberOptionalDefault——node22 · node24 · node26
gifFrames.watermark.xPublished gifFrames.watermark.x option.numberOptionalDefault——node22 · node24 · node26
gifFrames.watermark.yPublished gifFrames.watermark.y option.numberOptionalDefault——node22 · node24 · node26
options
options.attachmentNameAttachment filename; `.gif` is appended when omitted.stringOptionalDefault——node22 · node24 · node26
options.defaultDisposePublished options.defaultDispose option.GIFDisposalMethodOptionalDefault—0 2 1 3node22 · node24 · node26
options.delayDefault frame delay in milliseconds. GIF timing is rounded to 10ms units.numberOptionalDefault——node22 · node24 · node26
options.durationOptional generated-mode duration bound in milliseconds, converted to a frame bound using `delay`.numberOptionalDefault——node22 · node24 · node26
options.frameCountMaximum generated frames and the hint passed to onStart. The runtime maxGifFrames limit is always enforced.numberOptionalDefault——node22 · node24 · node26
options.heightPublished options.height option.numberOptionalDefault——node22 · node24 · node26
options.onEndPublished options.onEnd option.(finalFrameBuffer: Buffer<ArrayBufferLike>, painter: unknown) => Promise<Buffer<ArrayBufferLike>>OptionalDefault——node22 · node24 · node26
options.onStartGenerated-frame mode. Returning an AsyncIterable is the memory-bounded streaming path: one yielded frame is resolved, decoded, drawn and encoded before the next is requested.(frameCountHint: number, painter: unknown) => Promise<GIFEncodedFrame[] | AsyncIterable<GIFEncodedFrame>>OptionalDefault——node22 · node24 · node26
options.outputFilePublished options.outputFile option.stringOptionalDefault——node22 · node24 · node26
options.outputFormatPublished options.outputFormat option.GIFOutputFormatRequiredDefaultRequired"base64" "file" "attachment" "buffer"node22 · node24 · node26
options.qualityQuantizer sample interval 1..30; lower is higher quality/slower. Default 10.numberOptionalDefault——node22 · node24 · node26
options.repeat-1 = play once, 0 = loop forever, positive values = finite repeat count.numberOptionalDefault——node22 · node24 · node26
options.signalCancels further frame pulls, media requests, and encoding work between encoder frame commits.AbortSignalOptionalDefault——node22 · node24 · node26
options.skipResizeWhenDimensionsMatchFrames are stretched to the output dimensions; this only skips redundant scaling for exact-size frames.booleanOptionalDefault—false truenode22 · node24 · node26
options.textOverlayPublished options.textOverlay option.GIFTextOverlaySpecOptionalDefault——node22 · node24 · node26
options.textOverlay.boldPublished options.textOverlay.bold option.DeprecatedbooleanOptionalDefault—false truenode22 · node24 · node26
options.textOverlay.colorPublished options.textOverlay.color option.DeprecatedstringOptionalDefault——node22 · node24 · node26
options.textOverlay.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}).TextDecorationsOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.boldPublished options.textOverlay.decorations.bold option.booleanOptionalDefault—false truenode22 · node24 · node26
options.textOverlay.decorations.italicPublished options.textOverlay.decorations.italic option.booleanOptionalDefault—false truenode22 · node24 · node26
options.textOverlay.decorations.overlinePublished options.textOverlay.decorations.overline option.TextLineDecorationOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.overline.colorPublished options.textOverlay.decorations.overline.color option.stringOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.overline.gradientPublished options.textOverlay.decorations.overline.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.overline.gradient.colorsPublished options.textOverlay.decorations.overline.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.decorations.overline.gradient.colors.colorPublished options.textOverlay.decorations.overline.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.decorations.overline.gradient.colors.stopPublished options.textOverlay.decorations.overline.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.decorations.overline.gradient.endXPublished options.textOverlay.decorations.overline.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.overline.gradient.endYPublished options.textOverlay.decorations.overline.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.overline.gradient.pivotXPublished options.textOverlay.decorations.overline.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.overline.gradient.pivotYPublished options.textOverlay.decorations.overline.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.overline.gradient.repeatPublished options.textOverlay.decorations.overline.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.textOverlay.decorations.overline.gradient.rotatePublished options.textOverlay.decorations.overline.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.overline.gradient.startXPublished options.textOverlay.decorations.overline.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.overline.gradient.startYPublished options.textOverlay.decorations.overline.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.overline.gradient.typePublished options.textOverlay.decorations.overline.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.textOverlay.decorations.overline.gradient.endRadiusPublished options.textOverlay.decorations.overline.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.overline.gradient.startRadiusPublished options.textOverlay.decorations.overline.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.overline.gradient.centerXPublished options.textOverlay.decorations.overline.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.overline.gradient.centerYPublished options.textOverlay.decorations.overline.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.overline.gradient.startAnglePublished options.textOverlay.decorations.overline.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.overline.widthPublished options.textOverlay.decorations.overline.width option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.strikethroughPublished options.textOverlay.decorations.strikethrough option.TextLineDecorationOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.strikethrough.colorPublished options.textOverlay.decorations.strikethrough.color option.stringOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.strikethrough.gradientPublished options.textOverlay.decorations.strikethrough.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.strikethrough.gradient.colorsPublished options.textOverlay.decorations.strikethrough.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.decorations.strikethrough.gradient.colors.colorPublished options.textOverlay.decorations.strikethrough.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.decorations.strikethrough.gradient.colors.stopPublished options.textOverlay.decorations.strikethrough.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.decorations.strikethrough.gradient.endXPublished options.textOverlay.decorations.strikethrough.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.strikethrough.gradient.endYPublished options.textOverlay.decorations.strikethrough.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.strikethrough.gradient.pivotXPublished options.textOverlay.decorations.strikethrough.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.strikethrough.gradient.pivotYPublished options.textOverlay.decorations.strikethrough.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.strikethrough.gradient.repeatPublished options.textOverlay.decorations.strikethrough.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.textOverlay.decorations.strikethrough.gradient.rotatePublished options.textOverlay.decorations.strikethrough.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.strikethrough.gradient.startXPublished options.textOverlay.decorations.strikethrough.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.strikethrough.gradient.startYPublished options.textOverlay.decorations.strikethrough.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.strikethrough.gradient.typePublished options.textOverlay.decorations.strikethrough.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.textOverlay.decorations.strikethrough.gradient.endRadiusPublished options.textOverlay.decorations.strikethrough.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.strikethrough.gradient.startRadiusPublished options.textOverlay.decorations.strikethrough.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.strikethrough.gradient.centerXPublished options.textOverlay.decorations.strikethrough.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.strikethrough.gradient.centerYPublished options.textOverlay.decorations.strikethrough.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.strikethrough.gradient.startAnglePublished options.textOverlay.decorations.strikethrough.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.strikethrough.widthPublished options.textOverlay.decorations.strikethrough.width option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.underlinePublished options.textOverlay.decorations.underline option.TextLineDecorationOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.underline.colorPublished options.textOverlay.decorations.underline.color option.stringOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.underline.gradientPublished options.textOverlay.decorations.underline.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.underline.gradient.colorsPublished options.textOverlay.decorations.underline.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.decorations.underline.gradient.colors.colorPublished options.textOverlay.decorations.underline.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.decorations.underline.gradient.colors.stopPublished options.textOverlay.decorations.underline.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.decorations.underline.gradient.endXPublished options.textOverlay.decorations.underline.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.underline.gradient.endYPublished options.textOverlay.decorations.underline.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.underline.gradient.pivotXPublished options.textOverlay.decorations.underline.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.underline.gradient.pivotYPublished options.textOverlay.decorations.underline.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.underline.gradient.repeatPublished options.textOverlay.decorations.underline.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.textOverlay.decorations.underline.gradient.rotatePublished options.textOverlay.decorations.underline.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.underline.gradient.startXPublished options.textOverlay.decorations.underline.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.underline.gradient.startYPublished options.textOverlay.decorations.underline.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.underline.gradient.typePublished options.textOverlay.decorations.underline.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.textOverlay.decorations.underline.gradient.endRadiusPublished options.textOverlay.decorations.underline.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.underline.gradient.startRadiusPublished options.textOverlay.decorations.underline.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.underline.gradient.centerXPublished options.textOverlay.decorations.underline.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.underline.gradient.centerYPublished options.textOverlay.decorations.underline.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.underline.gradient.startAnglePublished options.textOverlay.decorations.underline.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.decorations.underline.widthPublished options.textOverlay.decorations.underline.width option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effectsGrouped highlight, glow, and shadow. When set, entries override the legacy flat fields (see {@link resolveTextEffects}).TextEffectsOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.glowPublished options.textOverlay.effects.glow option.TextGlowStyleOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.glow.colorPublished options.textOverlay.effects.glow.color option.stringOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.glow.gradientPublished options.textOverlay.effects.glow.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.glow.gradient.colorsPublished options.textOverlay.effects.glow.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.effects.glow.gradient.colors.colorPublished options.textOverlay.effects.glow.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.effects.glow.gradient.colors.stopPublished options.textOverlay.effects.glow.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.effects.glow.gradient.endXPublished options.textOverlay.effects.glow.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.glow.gradient.endYPublished options.textOverlay.effects.glow.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.glow.gradient.pivotXPublished options.textOverlay.effects.glow.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.glow.gradient.pivotYPublished options.textOverlay.effects.glow.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.glow.gradient.repeatPublished options.textOverlay.effects.glow.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.textOverlay.effects.glow.gradient.rotatePublished options.textOverlay.effects.glow.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.glow.gradient.startXPublished options.textOverlay.effects.glow.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.glow.gradient.startYPublished options.textOverlay.effects.glow.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.glow.gradient.typePublished options.textOverlay.effects.glow.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.textOverlay.effects.glow.gradient.endRadiusPublished options.textOverlay.effects.glow.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.glow.gradient.startRadiusPublished options.textOverlay.effects.glow.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.glow.gradient.centerXPublished options.textOverlay.effects.glow.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.glow.gradient.centerYPublished options.textOverlay.effects.glow.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.glow.gradient.startAnglePublished options.textOverlay.effects.glow.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.glow.intensityPublished options.textOverlay.effects.glow.intensity option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.glow.opacityPublished options.textOverlay.effects.glow.opacity option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.highlightPublished options.textOverlay.effects.highlight option.TextHighlightStyleOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.highlight.colorPublished options.textOverlay.effects.highlight.color option.stringOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.highlight.gradientPublished options.textOverlay.effects.highlight.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.highlight.gradient.colorsPublished options.textOverlay.effects.highlight.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.effects.highlight.gradient.colors.colorPublished options.textOverlay.effects.highlight.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.effects.highlight.gradient.colors.stopPublished options.textOverlay.effects.highlight.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.effects.highlight.gradient.endXPublished options.textOverlay.effects.highlight.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.highlight.gradient.endYPublished options.textOverlay.effects.highlight.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.highlight.gradient.pivotXPublished options.textOverlay.effects.highlight.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.highlight.gradient.pivotYPublished options.textOverlay.effects.highlight.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.highlight.gradient.repeatPublished options.textOverlay.effects.highlight.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.textOverlay.effects.highlight.gradient.rotatePublished options.textOverlay.effects.highlight.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.highlight.gradient.startXPublished options.textOverlay.effects.highlight.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.highlight.gradient.startYPublished options.textOverlay.effects.highlight.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.highlight.gradient.typePublished options.textOverlay.effects.highlight.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.textOverlay.effects.highlight.gradient.endRadiusPublished options.textOverlay.effects.highlight.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.highlight.gradient.startRadiusPublished options.textOverlay.effects.highlight.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.highlight.gradient.centerXPublished options.textOverlay.effects.highlight.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.highlight.gradient.centerYPublished options.textOverlay.effects.highlight.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.highlight.gradient.startAnglePublished options.textOverlay.effects.highlight.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.highlight.opacityPublished options.textOverlay.effects.highlight.opacity option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.shadowPublished options.textOverlay.effects.shadow option.TextShadowStyleOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.shadow.blurPublished options.textOverlay.effects.shadow.blur option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.shadow.colorPublished options.textOverlay.effects.shadow.color option.stringOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.shadow.gradientPublished options.textOverlay.effects.shadow.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.shadow.gradient.colorsPublished options.textOverlay.effects.shadow.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.effects.shadow.gradient.colors.colorPublished options.textOverlay.effects.shadow.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.effects.shadow.gradient.colors.stopPublished options.textOverlay.effects.shadow.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.effects.shadow.gradient.endXPublished options.textOverlay.effects.shadow.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.shadow.gradient.endYPublished options.textOverlay.effects.shadow.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.shadow.gradient.pivotXPublished options.textOverlay.effects.shadow.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.shadow.gradient.pivotYPublished options.textOverlay.effects.shadow.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.shadow.gradient.repeatPublished options.textOverlay.effects.shadow.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.textOverlay.effects.shadow.gradient.rotatePublished options.textOverlay.effects.shadow.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.shadow.gradient.startXPublished options.textOverlay.effects.shadow.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.shadow.gradient.startYPublished options.textOverlay.effects.shadow.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.shadow.gradient.typePublished options.textOverlay.effects.shadow.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.textOverlay.effects.shadow.gradient.endRadiusPublished options.textOverlay.effects.shadow.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.shadow.gradient.startRadiusPublished options.textOverlay.effects.shadow.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.shadow.gradient.centerXPublished options.textOverlay.effects.shadow.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.shadow.gradient.centerYPublished options.textOverlay.effects.shadow.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.shadow.gradient.startAnglePublished options.textOverlay.effects.shadow.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.shadow.offsetXPublished options.textOverlay.effects.shadow.offsetX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.shadow.offsetYPublished options.textOverlay.effects.shadow.offsetY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.effects.shadow.opacityPublished options.textOverlay.effects.shadow.opacity option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.fillGrouped fill color / gradient and draw opacity (see {@link resolveTextFill}).TextFillOptionalDefault——node22 · node24 · node26
options.textOverlay.fill.colorPublished options.textOverlay.fill.color option.stringOptionalDefault——node22 · node24 · node26
options.textOverlay.fill.gradientPublished options.textOverlay.fill.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.textOverlay.fill.gradient.colorsPublished options.textOverlay.fill.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.fill.gradient.colors.colorPublished options.textOverlay.fill.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.fill.gradient.colors.stopPublished options.textOverlay.fill.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.fill.gradient.endXPublished options.textOverlay.fill.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.fill.gradient.endYPublished options.textOverlay.fill.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.fill.gradient.pivotXPublished options.textOverlay.fill.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.fill.gradient.pivotYPublished options.textOverlay.fill.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.fill.gradient.repeatPublished options.textOverlay.fill.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.textOverlay.fill.gradient.rotatePublished options.textOverlay.fill.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.fill.gradient.startXPublished options.textOverlay.fill.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.fill.gradient.startYPublished options.textOverlay.fill.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.fill.gradient.typePublished options.textOverlay.fill.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.textOverlay.fill.gradient.endRadiusPublished options.textOverlay.fill.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.fill.gradient.startRadiusPublished options.textOverlay.fill.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.fill.gradient.centerXPublished options.textOverlay.fill.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.fill.gradient.centerYPublished options.textOverlay.fill.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.fill.gradient.startAnglePublished options.textOverlay.fill.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.fill.opacityPublished options.textOverlay.fill.opacity option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.fontPublished options.textOverlay.font option.{ size?: number; family?: string; name?: string; path?: string; }OptionalDefault——node22 · node24 · node26
options.textOverlay.font.familyPublished options.textOverlay.font.family option.stringOptionalDefault——node22 · node24 · node26
options.textOverlay.font.namePublished options.textOverlay.font.name option.stringOptionalDefault——node22 · node24 · node26
options.textOverlay.font.pathPublished options.textOverlay.font.path option.stringOptionalDefault——node22 · node24 · node26
options.textOverlay.font.sizePublished options.textOverlay.font.size option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.fontColorLegacy alias for `color`/`fill.color`.stringOptionalDefault——node22 · node24 · node26
options.textOverlay.fontFamilyPublished options.textOverlay.fontFamily option.DeprecatedstringOptionalDefault——node22 · node24 · node26
options.textOverlay.fontNamePublished options.textOverlay.fontName option.DeprecatedstringOptionalDefault——node22 · node24 · node26
options.textOverlay.fontPathPublished options.textOverlay.fontPath option.DeprecatedstringOptionalDefault——node22 · node24 · node26
options.textOverlay.fontSizePublished options.textOverlay.fontSize option.DeprecatednumberOptionalDefault——node22 · node24 · node26
options.textOverlay.glowPublished options.textOverlay.glow option.DeprecatedTextGlowStyleOptionalDefault——node22 · node24 · node26
options.textOverlay.glow.colorPublished options.textOverlay.glow.color option.stringOptionalDefault——node22 · node24 · node26
options.textOverlay.glow.gradientPublished options.textOverlay.glow.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.textOverlay.glow.gradient.colorsPublished options.textOverlay.glow.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.glow.gradient.colors.colorPublished options.textOverlay.glow.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.glow.gradient.colors.stopPublished options.textOverlay.glow.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.glow.gradient.endXPublished options.textOverlay.glow.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.glow.gradient.endYPublished options.textOverlay.glow.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.glow.gradient.pivotXPublished options.textOverlay.glow.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.glow.gradient.pivotYPublished options.textOverlay.glow.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.glow.gradient.repeatPublished options.textOverlay.glow.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.textOverlay.glow.gradient.rotatePublished options.textOverlay.glow.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.glow.gradient.startXPublished options.textOverlay.glow.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.glow.gradient.startYPublished options.textOverlay.glow.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.glow.gradient.typePublished options.textOverlay.glow.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.textOverlay.glow.gradient.endRadiusPublished options.textOverlay.glow.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.glow.gradient.startRadiusPublished options.textOverlay.glow.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.glow.gradient.centerXPublished options.textOverlay.glow.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.glow.gradient.centerYPublished options.textOverlay.glow.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.glow.gradient.startAnglePublished options.textOverlay.glow.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.glow.intensityPublished options.textOverlay.glow.intensity option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.glow.opacityPublished options.textOverlay.glow.opacity option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.gradientPublished options.textOverlay.gradient option.DeprecatedgradientOptionalDefault——node22 · node24 · node26
options.textOverlay.gradient.colorsPublished options.textOverlay.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.gradient.colors.colorPublished options.textOverlay.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.gradient.colors.stopPublished options.textOverlay.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.gradient.endXPublished options.textOverlay.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.gradient.endYPublished options.textOverlay.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.gradient.pivotXPublished options.textOverlay.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.gradient.pivotYPublished options.textOverlay.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.gradient.repeatPublished options.textOverlay.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.textOverlay.gradient.rotatePublished options.textOverlay.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.gradient.startXPublished options.textOverlay.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.gradient.startYPublished options.textOverlay.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.gradient.typePublished options.textOverlay.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.textOverlay.gradient.endRadiusPublished options.textOverlay.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.gradient.startRadiusPublished options.textOverlay.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.gradient.centerXPublished options.textOverlay.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.gradient.centerYPublished options.textOverlay.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.gradient.startAnglePublished options.textOverlay.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.highlightPublished options.textOverlay.highlight option.DeprecatedTextHighlightStyleOptionalDefault——node22 · node24 · node26
options.textOverlay.highlight.colorPublished options.textOverlay.highlight.color option.stringOptionalDefault——node22 · node24 · node26
options.textOverlay.highlight.gradientPublished options.textOverlay.highlight.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.textOverlay.highlight.gradient.colorsPublished options.textOverlay.highlight.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.highlight.gradient.colors.colorPublished options.textOverlay.highlight.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.highlight.gradient.colors.stopPublished options.textOverlay.highlight.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.highlight.gradient.endXPublished options.textOverlay.highlight.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.highlight.gradient.endYPublished options.textOverlay.highlight.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.highlight.gradient.pivotXPublished options.textOverlay.highlight.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.highlight.gradient.pivotYPublished options.textOverlay.highlight.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.highlight.gradient.repeatPublished options.textOverlay.highlight.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.textOverlay.highlight.gradient.rotatePublished options.textOverlay.highlight.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.highlight.gradient.startXPublished options.textOverlay.highlight.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.highlight.gradient.startYPublished options.textOverlay.highlight.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.highlight.gradient.typePublished options.textOverlay.highlight.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.textOverlay.highlight.gradient.endRadiusPublished options.textOverlay.highlight.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.highlight.gradient.startRadiusPublished options.textOverlay.highlight.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.highlight.gradient.centerXPublished options.textOverlay.highlight.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.highlight.gradient.centerYPublished options.textOverlay.highlight.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.highlight.gradient.startAnglePublished options.textOverlay.highlight.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.highlight.opacityPublished options.textOverlay.highlight.opacity option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.includeCharMetricsPublished options.textOverlay.includeCharMetrics option.booleanOptionalDefault—false truenode22 · node24 · node26
options.textOverlay.italicPublished options.textOverlay.italic option.DeprecatedbooleanOptionalDefault—false truenode22 · node24 · node26
options.textOverlay.layoutGrouped line height, spacing, and wrap bounds (see {@link resolveTextLayout}).TextLayoutOptionalDefault——node22 · node24 · node26
options.textOverlay.layout.letterSpacingPublished options.textOverlay.layout.letterSpacing option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.layout.lineHeightPublished options.textOverlay.layout.lineHeight option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.layout.maxHeightPublished options.textOverlay.layout.maxHeight option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.layout.maxWidthPublished options.textOverlay.layout.maxWidth option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.layout.wordSpacingPublished options.textOverlay.layout.wordSpacing option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.letterSpacingPublished options.textOverlay.letterSpacing option.DeprecatednumberOptionalDefault——node22 · node24 · node26
options.textOverlay.lineHeightPublished options.textOverlay.lineHeight option.DeprecatednumberOptionalDefault——node22 · node24 · node26
options.textOverlay.maxHeightPublished options.textOverlay.maxHeight option.DeprecatednumberOptionalDefault——node22 · node24 · node26
options.textOverlay.maxWidthPublished options.textOverlay.maxWidth option.DeprecatednumberOptionalDefault——node22 · node24 · node26
options.textOverlay.measurementCanvasPublished options.textOverlay.measurementCanvas option.{ width?: number; height?: number; }OptionalDefault——node22 · node24 · node26
options.textOverlay.measurementCanvas.heightPublished options.textOverlay.measurementCanvas.height option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.measurementCanvas.widthPublished options.textOverlay.measurementCanvas.width option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.opacityPublished options.textOverlay.opacity option.DeprecatednumberOptionalDefault——node22 · node24 · node26
options.textOverlay.overlinePublished options.textOverlay.overline option.DeprecatedTextLineDecorationOptionalDefault——node22 · node24 · node26
options.textOverlay.overline.colorPublished options.textOverlay.overline.color option.stringOptionalDefault——node22 · node24 · node26
options.textOverlay.overline.gradientPublished options.textOverlay.overline.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.textOverlay.overline.gradient.colorsPublished options.textOverlay.overline.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.overline.gradient.colors.colorPublished options.textOverlay.overline.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.overline.gradient.colors.stopPublished options.textOverlay.overline.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.overline.gradient.endXPublished options.textOverlay.overline.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.overline.gradient.endYPublished options.textOverlay.overline.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.overline.gradient.pivotXPublished options.textOverlay.overline.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.overline.gradient.pivotYPublished options.textOverlay.overline.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.overline.gradient.repeatPublished options.textOverlay.overline.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.textOverlay.overline.gradient.rotatePublished options.textOverlay.overline.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.overline.gradient.startXPublished options.textOverlay.overline.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.overline.gradient.startYPublished options.textOverlay.overline.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.overline.gradient.typePublished options.textOverlay.overline.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.textOverlay.overline.gradient.endRadiusPublished options.textOverlay.overline.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.overline.gradient.startRadiusPublished options.textOverlay.overline.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.overline.gradient.centerXPublished options.textOverlay.overline.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.overline.gradient.centerYPublished options.textOverlay.overline.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.overline.gradient.startAnglePublished options.textOverlay.overline.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.overline.widthPublished options.textOverlay.overline.width option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.placementGrouped alignment, baseline, and rotation (see {@link resolveTextPlacement}).TextPlacementOptionalDefault——node22 · node24 · node26
options.textOverlay.placement.rotationPublished options.textOverlay.placement.rotation option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.placement.textAlignPublished options.textOverlay.placement.textAlign option.TextAlignModeOptionalDefault—
5 values
"center" "left" "right" "start" "end"
node22 · node24 · node26
options.textOverlay.placement.textBaselinePublished options.textOverlay.placement.textBaseline option.TextBaselineModeOptionalDefault—
6 values
"top" "bottom" "alphabetic" "hanging" "ideographic" "middle"
node22 · node24 · node26
options.textOverlay.rotationPublished options.textOverlay.rotation option.DeprecatednumberOptionalDefault——node22 · node24 · node26
options.textOverlay.shadowPublished options.textOverlay.shadow option.DeprecatedTextShadowStyleOptionalDefault——node22 · node24 · node26
options.textOverlay.shadow.blurPublished options.textOverlay.shadow.blur option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.shadow.colorPublished options.textOverlay.shadow.color option.stringOptionalDefault——node22 · node24 · node26
options.textOverlay.shadow.gradientPublished options.textOverlay.shadow.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.textOverlay.shadow.gradient.colorsPublished options.textOverlay.shadow.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.shadow.gradient.colors.colorPublished options.textOverlay.shadow.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.shadow.gradient.colors.stopPublished options.textOverlay.shadow.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.shadow.gradient.endXPublished options.textOverlay.shadow.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.shadow.gradient.endYPublished options.textOverlay.shadow.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.shadow.gradient.pivotXPublished options.textOverlay.shadow.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.shadow.gradient.pivotYPublished options.textOverlay.shadow.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.shadow.gradient.repeatPublished options.textOverlay.shadow.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.textOverlay.shadow.gradient.rotatePublished options.textOverlay.shadow.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.shadow.gradient.startXPublished options.textOverlay.shadow.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.shadow.gradient.startYPublished options.textOverlay.shadow.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.shadow.gradient.typePublished options.textOverlay.shadow.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.textOverlay.shadow.gradient.endRadiusPublished options.textOverlay.shadow.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.shadow.gradient.startRadiusPublished options.textOverlay.shadow.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.shadow.gradient.centerXPublished options.textOverlay.shadow.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.shadow.gradient.centerYPublished options.textOverlay.shadow.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.shadow.gradient.startAnglePublished options.textOverlay.shadow.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.shadow.offsetXPublished options.textOverlay.shadow.offsetX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.shadow.offsetYPublished options.textOverlay.shadow.offsetY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.shadow.opacityPublished options.textOverlay.shadow.opacity option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.strikethroughPublished options.textOverlay.strikethrough option.DeprecatedTextLineDecorationOptionalDefault——node22 · node24 · node26
options.textOverlay.strikethrough.colorPublished options.textOverlay.strikethrough.color option.stringOptionalDefault——node22 · node24 · node26
options.textOverlay.strikethrough.gradientPublished options.textOverlay.strikethrough.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.textOverlay.strikethrough.gradient.colorsPublished options.textOverlay.strikethrough.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.strikethrough.gradient.colors.colorPublished options.textOverlay.strikethrough.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.strikethrough.gradient.colors.stopPublished options.textOverlay.strikethrough.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.strikethrough.gradient.endXPublished options.textOverlay.strikethrough.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.strikethrough.gradient.endYPublished options.textOverlay.strikethrough.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.strikethrough.gradient.pivotXPublished options.textOverlay.strikethrough.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.strikethrough.gradient.pivotYPublished options.textOverlay.strikethrough.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.strikethrough.gradient.repeatPublished options.textOverlay.strikethrough.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.textOverlay.strikethrough.gradient.rotatePublished options.textOverlay.strikethrough.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.strikethrough.gradient.startXPublished options.textOverlay.strikethrough.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.strikethrough.gradient.startYPublished options.textOverlay.strikethrough.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.strikethrough.gradient.typePublished options.textOverlay.strikethrough.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.textOverlay.strikethrough.gradient.endRadiusPublished options.textOverlay.strikethrough.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.strikethrough.gradient.startRadiusPublished options.textOverlay.strikethrough.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.strikethrough.gradient.centerXPublished options.textOverlay.strikethrough.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.strikethrough.gradient.centerYPublished options.textOverlay.strikethrough.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.strikethrough.gradient.startAnglePublished options.textOverlay.strikethrough.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.strikethrough.widthPublished options.textOverlay.strikethrough.width option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.strokePublished options.textOverlay.stroke option.TextStrokeStyleOptionalDefault——node22 · node24 · node26
options.textOverlay.stroke.colorPublished options.textOverlay.stroke.color option.stringOptionalDefault——node22 · node24 · node26
options.textOverlay.stroke.gradientPublished options.textOverlay.stroke.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.textOverlay.stroke.gradient.colorsPublished options.textOverlay.stroke.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.stroke.gradient.colors.colorPublished options.textOverlay.stroke.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.stroke.gradient.colors.stopPublished options.textOverlay.stroke.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.stroke.gradient.endXPublished options.textOverlay.stroke.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.stroke.gradient.endYPublished options.textOverlay.stroke.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.stroke.gradient.pivotXPublished options.textOverlay.stroke.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.stroke.gradient.pivotYPublished options.textOverlay.stroke.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.stroke.gradient.repeatPublished options.textOverlay.stroke.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.textOverlay.stroke.gradient.rotatePublished options.textOverlay.stroke.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.stroke.gradient.startXPublished options.textOverlay.stroke.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.stroke.gradient.startYPublished options.textOverlay.stroke.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.stroke.gradient.typePublished options.textOverlay.stroke.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.textOverlay.stroke.gradient.endRadiusPublished options.textOverlay.stroke.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.stroke.gradient.startRadiusPublished options.textOverlay.stroke.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.stroke.gradient.centerXPublished options.textOverlay.stroke.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.stroke.gradient.centerYPublished options.textOverlay.stroke.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.stroke.gradient.startAnglePublished options.textOverlay.stroke.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.stroke.opacityPublished options.textOverlay.stroke.opacity option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.stroke.stylePublished options.textOverlay.stroke.style option."solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"OptionalDefault—
6 values
"solid" "dashed" "dotted" "groove" "ridge" "double"
node22 · node24 · node26
options.textOverlay.stroke.widthPublished options.textOverlay.stroke.width option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.textPublished options.textOverlay.text option.stringRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.textAlignPublished options.textOverlay.textAlign option.DeprecatedTextAlignModeOptionalDefault—
5 values
"center" "left" "right" "start" "end"
node22 · node24 · node26
options.textOverlay.textBaselinePublished options.textOverlay.textBaseline option.DeprecatedTextBaselineModeOptionalDefault—
6 values
"top" "bottom" "alphabetic" "hanging" "ideographic" "middle"
node22 · node24 · node26
options.textOverlay.textOnCurvePublished options.textOverlay.textOnCurve option.DeprecatedTextCurveConfigOptionalDefault——node22 · node24 · node26
options.textOverlay.textOnCurve.baselineOffsetPublished options.textOverlay.textOnCurve.baselineOffset option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.textOnCurve.layoutModePublished options.textOverlay.textOnCurve.layoutMode option.CurvedTextLayoutModeOptionalDefault—"fit" "clamp" "override"node22 · node24 · node26
options.textOverlay.textOnCurve.radiusPublished options.textOverlay.textOnCurve.radius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.textOnCurve.startAngleDegPublished options.textOverlay.textOnCurve.startAngleDeg option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.textOnCurve.sweepAnglePublished options.textOverlay.textOnCurve.sweepAngle option.numberRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.textOnCurve.upPublished options.textOverlay.textOnCurve.up option.booleanOptionalDefault—false truenode22 · node24 · node26
options.textOverlay.underlinePublished options.textOverlay.underline option.DeprecatedTextLineDecorationOptionalDefault——node22 · node24 · node26
options.textOverlay.underline.colorPublished options.textOverlay.underline.color option.stringOptionalDefault——node22 · node24 · node26
options.textOverlay.underline.gradientPublished options.textOverlay.underline.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.textOverlay.underline.gradient.colorsPublished options.textOverlay.underline.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.underline.gradient.colors.colorPublished options.textOverlay.underline.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.underline.gradient.colors.stopPublished options.textOverlay.underline.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.textOverlay.underline.gradient.endXPublished options.textOverlay.underline.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.underline.gradient.endYPublished options.textOverlay.underline.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.underline.gradient.pivotXPublished options.textOverlay.underline.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.underline.gradient.pivotYPublished options.textOverlay.underline.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.underline.gradient.repeatPublished options.textOverlay.underline.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.textOverlay.underline.gradient.rotatePublished options.textOverlay.underline.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.underline.gradient.startXPublished options.textOverlay.underline.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.underline.gradient.startYPublished options.textOverlay.underline.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.underline.gradient.typePublished options.textOverlay.underline.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.textOverlay.underline.gradient.endRadiusPublished options.textOverlay.underline.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.underline.gradient.startRadiusPublished options.textOverlay.underline.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.underline.gradient.centerXPublished options.textOverlay.underline.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.underline.gradient.centerYPublished options.textOverlay.underline.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.underline.gradient.startAnglePublished options.textOverlay.underline.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.underline.widthPublished options.textOverlay.underline.width option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.wordSpacingPublished options.textOverlay.wordSpacing option.DeprecatednumberOptionalDefault——node22 · node24 · node26
options.textOverlay.xPublished options.textOverlay.x option.numberOptionalDefault——node22 · node24 · node26
options.textOverlay.yPublished options.textOverlay.y option.numberOptionalDefault——node22 · node24 · node26
options.transparentColorPublished options.transparentColor option.string | numberOptionalDefault——node22 · node24 · node26
options.watermarkPublished options.watermark option.GIFWatermarkSpecOptionalDefault——node22 · node24 · node26
options.watermark.enablePublished options.watermark.enable option.booleanOptionalDefault—false truenode22 · node24 · node26
options.watermark.heightPublished options.watermark.height option.numberOptionalDefault——node22 · node24 · node26
options.watermark.marginPublished options.watermark.margin option.numberOptionalDefault——node22 · node24 · node26
options.watermark.opacityPublished options.watermark.opacity option.numberOptionalDefault——node22 · node24 · node26
options.watermark.positionPublished options.watermark.position option.GIFWatermarkPositionOptionalDefault—
5 values
"center" "top-left" "top-right" "bottom-left" "bottom-right"
node22 · node24 · node26
options.watermark.scalePublished options.watermark.scale option.numberOptionalDefault——node22 · node24 · node26
options.watermark.urlPublished options.watermark.url option.GIFFrameSourceRequiredDefaultRequired—node22 · node24 · node26
options.watermark.widthPublished options.watermark.width option.numberOptionalDefault——node22 · node24 · node26
options.watermark.xPublished options.watermark.x option.numberOptionalDefault——node22 · node24 · node26
options.watermark.yPublished options.watermark.y option.numberOptionalDefault——node22 · node24 · node26
options.widthPublished options.width option.numberOptionalDefault——node22 · node24 · node26
painterOpts
painterOpts.resolveAssetRefsWhen **true**, string leaves in the payload are resolved via {@link AssetManager.resolve } (same rules as {@link ApexPainter.prepareForRender } / {@link ApexPainter.renderScene }).booleanOptionalDefault—false truenode22 · node24 · node26

gifFrames.background

Optional

Exactly one of `buffer` or `background` is required.

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

gifFrames.buffer

Optional

Exactly one of `buffer` or `background` is required.

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

gifFrames.dispose

Optional

Published gifFrames.dispose option.

Type
GIFDisposalMethod
Default
—
Allowed
0 2 1 3
Runtime
node22, node24, node26

gifFrames.duration

Optional

Milliseconds. If omitted, `GIFOptions.delay` (default 100ms) is used.

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

gifFrames.transparentColor

Optional

Published gifFrames.transparentColor option.

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

gifFrames.watermark

Optional

Published gifFrames.watermark option.

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

gifFrames.watermark.enable

Optional

Published gifFrames.watermark.enable option.

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

gifFrames.watermark.height

Optional

Published gifFrames.watermark.height option.

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

gifFrames.watermark.margin

Optional

Published gifFrames.watermark.margin option.

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

gifFrames.watermark.opacity

Optional

Published gifFrames.watermark.opacity option.

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

gifFrames.watermark.position

Optional

Published gifFrames.watermark.position option.

Type
GIFWatermarkPosition
Default
—
Allowed
5 values
"center" "top-left" "top-right" "bottom-left" "bottom-right"
Runtime
node22, node24, node26

gifFrames.watermark.scale

Optional

Published gifFrames.watermark.scale option.

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

gifFrames.watermark.url

Required

Published gifFrames.watermark.url option.

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

gifFrames.watermark.width

Optional

Published gifFrames.watermark.width option.

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

gifFrames.watermark.x

Optional

Published gifFrames.watermark.x option.

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

gifFrames.watermark.y

Optional

Published gifFrames.watermark.y option.

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

options.attachmentName

Optional

Attachment filename; `.gif` is appended when omitted.

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

options.defaultDispose

Optional

Published options.defaultDispose option.

Type
GIFDisposalMethod
Default
—
Allowed
0 2 1 3
Runtime
node22, node24, node26

options.delay

Optional

Default frame delay in milliseconds. GIF timing is rounded to 10ms units.

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

options.duration

Optional

Optional generated-mode duration bound in milliseconds, converted to a frame bound using `delay`.

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

options.frameCount

Optional

Maximum generated frames and the hint passed to onStart. The runtime maxGifFrames limit is always enforced.

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

options.height

Optional

Published options.height option.

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

options.onEnd

Optional

Published options.onEnd option.

Type
(finalFrameBuffer: Buffer<ArrayBufferLike>, painter: unknown) => Promise<Buffer<ArrayBufferLike>>
Default
—
Allowed
—
Runtime
node22, node24, node26

options.onStart

Optional

Generated-frame mode. Returning an AsyncIterable is the memory-bounded streaming path: one yielded frame is resolved, decoded, drawn and encoded before the next is requested.

Type
(frameCountHint: number, painter: unknown) => Promise<GIFEncodedFrame[] | AsyncIterable<GIFEncodedFrame>>
Default
—
Allowed
—
Runtime
node22, node24, node26

options.outputFile

Optional

Published options.outputFile option.

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

options.outputFormat

Required

Published options.outputFormat option.

Type
GIFOutputFormat
Default
Required
Allowed
"base64" "file" "attachment" "buffer"
Runtime
node22, node24, node26

options.quality

Optional

Quantizer sample interval 1..30; lower is higher quality/slower. Default 10.

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

options.repeat

Optional

-1 = play once, 0 = loop forever, positive values = finite repeat count.

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

options.signal

Optional

Cancels further frame pulls, media requests, and encoding work between encoder frame commits.

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

options.skipResizeWhenDimensionsMatch

Optional

Frames are stretched to the output dimensions; this only skips redundant scaling for exact-size frames.

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

options.textOverlay

Optional

Published options.textOverlay option.

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

options.textOverlay.bold

Optional

Published options.textOverlay.bold option.

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

options.textOverlay.color

Optional

Published options.textOverlay.color option.

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

options.textOverlay.decorations

Optional

Grouped line decorations (`underline` / `overline` / `strikethrough`) and optional `bold` / `italic` flags for the canvas font string. Nested keys override the legacy flat fields (see {@link resolveTextDecorations}).

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

options.textOverlay.effects

Optional

Grouped highlight, glow, and shadow. When set, entries override the legacy flat fields (see {@link resolveTextEffects}).

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

options.textOverlay.fill

Optional

Grouped fill color / gradient and draw opacity (see {@link resolveTextFill}).

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

options.textOverlay.fill.gradient.repeat

Optional

Published options.textOverlay.fill.gradient.repeat option.

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

options.textOverlay.font

Optional

Published options.textOverlay.font option.

Type
{ size?: number; family?: string; name?: string; path?: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.textOverlay.fontName

Optional

Published options.textOverlay.fontName option.

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

options.textOverlay.fontPath

Optional

Published options.textOverlay.fontPath option.

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

options.textOverlay.fontSize

Optional

Published options.textOverlay.fontSize option.

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

options.textOverlay.glow

Optional

Published options.textOverlay.glow option.

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

options.textOverlay.glow.gradient.repeat

Optional

Published options.textOverlay.glow.gradient.repeat option.

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

options.textOverlay.gradient

Optional

Published options.textOverlay.gradient option.

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

options.textOverlay.gradient.repeat

Optional

Published options.textOverlay.gradient.repeat option.

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

options.textOverlay.highlight

Optional

Published options.textOverlay.highlight option.

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

options.textOverlay.highlight.gradient.repeat

Optional

Published options.textOverlay.highlight.gradient.repeat option.

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

options.textOverlay.italic

Optional

Published options.textOverlay.italic option.

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

options.textOverlay.layout

Optional

Grouped line height, spacing, and wrap bounds (see {@link resolveTextLayout}).

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

options.textOverlay.maxWidth

Optional

Published options.textOverlay.maxWidth option.

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

options.textOverlay.measurementCanvas

Optional

Published options.textOverlay.measurementCanvas option.

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

options.textOverlay.opacity

Optional

Published options.textOverlay.opacity option.

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

options.textOverlay.overline

Optional

Published options.textOverlay.overline option.

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

options.textOverlay.overline.gradient.repeat

Optional

Published options.textOverlay.overline.gradient.repeat option.

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

options.textOverlay.placement

Optional

Grouped alignment, baseline, and rotation (see {@link resolveTextPlacement}).

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

options.textOverlay.placement.textAlign

Optional

Published options.textOverlay.placement.textAlign option.

Type
TextAlignMode
Default
—
Allowed
5 values
"center" "left" "right" "start" "end"
Runtime
node22, node24, node26

options.textOverlay.placement.textBaseline

Optional

Published options.textOverlay.placement.textBaseline option.

Type
TextBaselineMode
Default
—
Allowed
6 values
"top" "bottom" "alphabetic" "hanging" "ideographic" "middle"
Runtime
node22, node24, node26

options.textOverlay.rotation

Optional

Published options.textOverlay.rotation option.

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

options.textOverlay.shadow

Optional

Published options.textOverlay.shadow option.

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

options.textOverlay.shadow.gradient.repeat

Optional

Published options.textOverlay.shadow.gradient.repeat option.

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

options.textOverlay.stroke

Optional

Published options.textOverlay.stroke option.

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

options.textOverlay.stroke.gradient.repeat

Optional

Published options.textOverlay.stroke.gradient.repeat option.

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

options.textOverlay.stroke.style

Optional

Published options.textOverlay.stroke.style option.

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

options.textOverlay.text

Required

Published options.textOverlay.text option.

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

options.textOverlay.textAlign

Optional

Published options.textOverlay.textAlign option.

Type
TextAlignMode
Default
—
Allowed
5 values
"center" "left" "right" "start" "end"
Runtime
node22, node24, node26

options.textOverlay.textBaseline

Optional

Published options.textOverlay.textBaseline option.

Type
TextBaselineMode
Default
—
Allowed
6 values
"top" "bottom" "alphabetic" "hanging" "ideographic" "middle"
Runtime
node22, node24, node26

options.textOverlay.textOnCurve

Optional

Published options.textOverlay.textOnCurve option.

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

options.textOverlay.underline

Optional

Published options.textOverlay.underline option.

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

options.textOverlay.underline.gradient.repeat

Optional

Published options.textOverlay.underline.gradient.repeat option.

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

options.textOverlay.x

Optional

Published options.textOverlay.x option.

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

options.textOverlay.y

Optional

Published options.textOverlay.y option.

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

options.transparentColor

Optional

Published options.transparentColor option.

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

options.watermark

Optional

Published options.watermark option.

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

options.watermark.enable

Optional

Published options.watermark.enable option.

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

options.watermark.height

Optional

Published options.watermark.height option.

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

options.watermark.margin

Optional

Published options.watermark.margin option.

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

options.watermark.opacity

Optional

Published options.watermark.opacity option.

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

options.watermark.position

Optional

Published options.watermark.position option.

Type
GIFWatermarkPosition
Default
—
Allowed
5 values
"center" "top-left" "top-right" "bottom-left" "bottom-right"
Runtime
node22, node24, node26

options.watermark.scale

Optional

Published options.watermark.scale option.

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

options.watermark.url

Required

Published options.watermark.url option.

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

options.watermark.width

Optional

Published options.watermark.width option.

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

options.watermark.x

Optional

Published options.watermark.x option.

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

options.watermark.y

Optional

Published options.watermark.y option.

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

options.width

Optional

Published options.width option.

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

painterOpts.resolveAssetRefs

Optional

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

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

Types

GIFInputFrame[]
  • variant 1
    GIFInputFrame: GIFInputFrame
    • duration?number
    • buffer?
      GIFFrameSource
      • variant 1string
      • variant 2Buffer<ArrayBufferLike>
      • variant 3Uint8Array<ArrayBufferLike>
      • variant 4URL
    • background?
      GIFFrameSource
      • variant 1string
      • variant 2Buffer<ArrayBufferLike>
      • variant 3Uint8Array<ArrayBufferLike>
      • variant 4URL
    • dispose?
      GIFDisposalMethod
      • variant 10
      • variant 22
      • variant 31
      • variant 43
    • transparentColor?
      string | number
      • variant 1string
      • variant 2number
    • watermark?
      GIFWatermarkSpec: GIFWatermarkSpec
      • enable?boolean
      • url
        GIFFrameSource
        • variant 1string
        • variant 2Buffer<ArrayBufferLike>
        • variant 3Uint8Array<ArrayBufferLike>
        • variant 4URL
      • x?number
      • y?number
      • opacity?number
      • width?number
      • height?number
      • scale?number
      • margin?number
      • position?
        GIFWatermarkPosition
        • variant 1"center"
        • variant 2"top-left"
        • variant 3"top-right"
        • variant 4"bottom-left"
        • variant 5"bottom-right"
GIFOptions: GIFOptions
  • outputFormat
    GIFOutputFormat
    • variant 1"base64"
    • variant 2"file"
    • variant 3"attachment"
    • variant 4"buffer"
  • outputFile?string
  • attachmentName?string
  • width?number
  • height?number
  • repeat?number
  • quality?number
  • delay?number
  • watermark?
    GIFWatermarkSpec: GIFWatermarkSpec
    • enable?boolean
    • url
      GIFFrameSource
      • variant 1string
      • variant 2Buffer<ArrayBufferLike>
      • variant 3Uint8Array<ArrayBufferLike>
      • variant 4URL
    • x?number
    • y?number
    • opacity?number
    • width?number
    • height?number
    • scale?number
    • margin?number
    • position?
      GIFWatermarkPosition
      • variant 1"center"
      • variant 2"top-left"
      • variant 3"top-right"
      • variant 4"bottom-left"
      • variant 5"bottom-right"
  • transparentColor?
    string | number
    • variant 1string
    • variant 2number
  • defaultDispose?
    GIFDisposalMethod
    • variant 10
    • variant 22
    • variant 31
    • variant 43
  • textOverlay?
    GIFTextOverlaySpec
    • variant 1Omit<TextProperties, "x" | "y">
    • variant 2
      __type: { x?: number; y?: number; fontColor?: string; }
      • x?number
      • y?number
      • fontColor?string
  • skipResizeWhenDimensionsMatch?boolean
  • onStart?(frameCountHint: number, painter: unknown) => Promise<GIFEncodedFrame[] | AsyncIterable<GIFEncodedFrame>>
  • frameCount?number
  • duration?number
  • onEnd?(finalFrameBuffer: Buffer<ArrayBufferLike>, painter: unknown) => Promise<Buffer<ArrayBufferLike>>
  • signal?AbortSignal
PainterAssetRefsOptions: PainterAssetRefsOptions
  • resolveAssetRefs?boolean

Return value

Promise<Buffer<ArrayBufferLike> | GIFPrimaryResult | { gif: GIFPrimaryResult; static: 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.

Verified examples

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

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

Next steps

ApexPainter._detectAPI member · node · CURRENT

Published ApexPainter._detect property.

ApexPainter._outputAPI member · node · CURRENT

Published ApexPainter._output property.

ApexPainter._outputFormatAPI member · node · CURRENT

Published ApexPainter._outputFormat property.

ApexPainter._path2dAPI member · node · CURRENT

Published ApexPainter._path2d property.