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

ApexPainter member

ApexPainter.measureText

Published ApexPainter.measureText method.

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

Signature

TypeScript
(textProps: TextProperties, painterOpts?: PainterAssetRefsOptions) => Promise<TextMetrics>

Parameters

Options

372 / 372 option paths
OptionTypeContractAllowed valuesRuntime & capabilities
textProps
textProps.boldPublished textProps.bold option.DeprecatedbooleanOptionalDefault—false truenode22 · node24 · node26
textProps.colorPublished textProps.color option.DeprecatedstringOptionalDefault——node22 · node24 · node26
textProps.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
textProps.decorations.boldPublished textProps.decorations.bold option.booleanOptionalDefault—false truenode22 · node24 · node26
textProps.decorations.italicPublished textProps.decorations.italic option.booleanOptionalDefault—false truenode22 · node24 · node26
textProps.decorations.overlinePublished textProps.decorations.overline option.TextLineDecorationOptionalDefault——node22 · node24 · node26
textProps.decorations.overline.colorPublished textProps.decorations.overline.color option.stringOptionalDefault——node22 · node24 · node26
textProps.decorations.overline.gradientPublished textProps.decorations.overline.gradient option.gradientOptionalDefault——node22 · node24 · node26
textProps.decorations.overline.gradient.colorsPublished textProps.decorations.overline.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
textProps.decorations.overline.gradient.colors.colorPublished textProps.decorations.overline.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
textProps.decorations.overline.gradient.colors.stopPublished textProps.decorations.overline.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
textProps.decorations.overline.gradient.endXPublished textProps.decorations.overline.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.overline.gradient.endYPublished textProps.decorations.overline.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.overline.gradient.pivotXPublished textProps.decorations.overline.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.overline.gradient.pivotYPublished textProps.decorations.overline.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.overline.gradient.repeatPublished textProps.decorations.overline.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
textProps.decorations.overline.gradient.rotatePublished textProps.decorations.overline.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.overline.gradient.startXPublished textProps.decorations.overline.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.overline.gradient.startYPublished textProps.decorations.overline.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.overline.gradient.typePublished textProps.decorations.overline.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
textProps.decorations.overline.gradient.endRadiusPublished textProps.decorations.overline.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.overline.gradient.startRadiusPublished textProps.decorations.overline.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.overline.gradient.centerXPublished textProps.decorations.overline.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.overline.gradient.centerYPublished textProps.decorations.overline.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.overline.gradient.startAnglePublished textProps.decorations.overline.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.overline.widthPublished textProps.decorations.overline.width option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.strikethroughPublished textProps.decorations.strikethrough option.TextLineDecorationOptionalDefault——node22 · node24 · node26
textProps.decorations.strikethrough.colorPublished textProps.decorations.strikethrough.color option.stringOptionalDefault——node22 · node24 · node26
textProps.decorations.strikethrough.gradientPublished textProps.decorations.strikethrough.gradient option.gradientOptionalDefault——node22 · node24 · node26
textProps.decorations.strikethrough.gradient.colorsPublished textProps.decorations.strikethrough.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
textProps.decorations.strikethrough.gradient.colors.colorPublished textProps.decorations.strikethrough.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
textProps.decorations.strikethrough.gradient.colors.stopPublished textProps.decorations.strikethrough.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
textProps.decorations.strikethrough.gradient.endXPublished textProps.decorations.strikethrough.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.strikethrough.gradient.endYPublished textProps.decorations.strikethrough.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.strikethrough.gradient.pivotXPublished textProps.decorations.strikethrough.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.strikethrough.gradient.pivotYPublished textProps.decorations.strikethrough.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.strikethrough.gradient.repeatPublished textProps.decorations.strikethrough.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
textProps.decorations.strikethrough.gradient.rotatePublished textProps.decorations.strikethrough.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.strikethrough.gradient.startXPublished textProps.decorations.strikethrough.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.strikethrough.gradient.startYPublished textProps.decorations.strikethrough.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.strikethrough.gradient.typePublished textProps.decorations.strikethrough.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
textProps.decorations.strikethrough.gradient.endRadiusPublished textProps.decorations.strikethrough.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.strikethrough.gradient.startRadiusPublished textProps.decorations.strikethrough.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.strikethrough.gradient.centerXPublished textProps.decorations.strikethrough.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.strikethrough.gradient.centerYPublished textProps.decorations.strikethrough.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.strikethrough.gradient.startAnglePublished textProps.decorations.strikethrough.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.strikethrough.widthPublished textProps.decorations.strikethrough.width option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.underlinePublished textProps.decorations.underline option.TextLineDecorationOptionalDefault——node22 · node24 · node26
textProps.decorations.underline.colorPublished textProps.decorations.underline.color option.stringOptionalDefault——node22 · node24 · node26
textProps.decorations.underline.gradientPublished textProps.decorations.underline.gradient option.gradientOptionalDefault——node22 · node24 · node26
textProps.decorations.underline.gradient.colorsPublished textProps.decorations.underline.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
textProps.decorations.underline.gradient.colors.colorPublished textProps.decorations.underline.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
textProps.decorations.underline.gradient.colors.stopPublished textProps.decorations.underline.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
textProps.decorations.underline.gradient.endXPublished textProps.decorations.underline.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.underline.gradient.endYPublished textProps.decorations.underline.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.underline.gradient.pivotXPublished textProps.decorations.underline.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.underline.gradient.pivotYPublished textProps.decorations.underline.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.underline.gradient.repeatPublished textProps.decorations.underline.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
textProps.decorations.underline.gradient.rotatePublished textProps.decorations.underline.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.underline.gradient.startXPublished textProps.decorations.underline.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.underline.gradient.startYPublished textProps.decorations.underline.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.underline.gradient.typePublished textProps.decorations.underline.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
textProps.decorations.underline.gradient.endRadiusPublished textProps.decorations.underline.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.underline.gradient.startRadiusPublished textProps.decorations.underline.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.underline.gradient.centerXPublished textProps.decorations.underline.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.underline.gradient.centerYPublished textProps.decorations.underline.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.underline.gradient.startAnglePublished textProps.decorations.underline.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
textProps.decorations.underline.widthPublished textProps.decorations.underline.width option.numberOptionalDefault——node22 · node24 · node26
textProps.effectsGrouped highlight, glow, and shadow. When set, entries override the legacy flat fields (see {@link resolveTextEffects}).TextEffectsOptionalDefault——node22 · node24 · node26
textProps.effects.glowPublished textProps.effects.glow option.TextGlowStyleOptionalDefault——node22 · node24 · node26
textProps.effects.glow.colorPublished textProps.effects.glow.color option.stringOptionalDefault——node22 · node24 · node26
textProps.effects.glow.gradientPublished textProps.effects.glow.gradient option.gradientOptionalDefault——node22 · node24 · node26
textProps.effects.glow.gradient.colorsPublished textProps.effects.glow.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
textProps.effects.glow.gradient.colors.colorPublished textProps.effects.glow.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
textProps.effects.glow.gradient.colors.stopPublished textProps.effects.glow.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
textProps.effects.glow.gradient.endXPublished textProps.effects.glow.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.glow.gradient.endYPublished textProps.effects.glow.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.glow.gradient.pivotXPublished textProps.effects.glow.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.glow.gradient.pivotYPublished textProps.effects.glow.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.glow.gradient.repeatPublished textProps.effects.glow.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
textProps.effects.glow.gradient.rotatePublished textProps.effects.glow.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.glow.gradient.startXPublished textProps.effects.glow.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.glow.gradient.startYPublished textProps.effects.glow.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.glow.gradient.typePublished textProps.effects.glow.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
textProps.effects.glow.gradient.endRadiusPublished textProps.effects.glow.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.glow.gradient.startRadiusPublished textProps.effects.glow.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.glow.gradient.centerXPublished textProps.effects.glow.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.glow.gradient.centerYPublished textProps.effects.glow.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.glow.gradient.startAnglePublished textProps.effects.glow.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.glow.intensityPublished textProps.effects.glow.intensity option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.glow.opacityPublished textProps.effects.glow.opacity option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.highlightPublished textProps.effects.highlight option.TextHighlightStyleOptionalDefault——node22 · node24 · node26
textProps.effects.highlight.colorPublished textProps.effects.highlight.color option.stringOptionalDefault——node22 · node24 · node26
textProps.effects.highlight.gradientPublished textProps.effects.highlight.gradient option.gradientOptionalDefault——node22 · node24 · node26
textProps.effects.highlight.gradient.colorsPublished textProps.effects.highlight.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
textProps.effects.highlight.gradient.colors.colorPublished textProps.effects.highlight.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
textProps.effects.highlight.gradient.colors.stopPublished textProps.effects.highlight.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
textProps.effects.highlight.gradient.endXPublished textProps.effects.highlight.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.highlight.gradient.endYPublished textProps.effects.highlight.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.highlight.gradient.pivotXPublished textProps.effects.highlight.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.highlight.gradient.pivotYPublished textProps.effects.highlight.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.highlight.gradient.repeatPublished textProps.effects.highlight.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
textProps.effects.highlight.gradient.rotatePublished textProps.effects.highlight.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.highlight.gradient.startXPublished textProps.effects.highlight.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.highlight.gradient.startYPublished textProps.effects.highlight.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.highlight.gradient.typePublished textProps.effects.highlight.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
textProps.effects.highlight.gradient.endRadiusPublished textProps.effects.highlight.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.highlight.gradient.startRadiusPublished textProps.effects.highlight.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.highlight.gradient.centerXPublished textProps.effects.highlight.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.highlight.gradient.centerYPublished textProps.effects.highlight.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.highlight.gradient.startAnglePublished textProps.effects.highlight.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.highlight.opacityPublished textProps.effects.highlight.opacity option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.shadowPublished textProps.effects.shadow option.TextShadowStyleOptionalDefault——node22 · node24 · node26
textProps.effects.shadow.blurPublished textProps.effects.shadow.blur option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.shadow.colorPublished textProps.effects.shadow.color option.stringOptionalDefault——node22 · node24 · node26
textProps.effects.shadow.gradientPublished textProps.effects.shadow.gradient option.gradientOptionalDefault——node22 · node24 · node26
textProps.effects.shadow.gradient.colorsPublished textProps.effects.shadow.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
textProps.effects.shadow.gradient.colors.colorPublished textProps.effects.shadow.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
textProps.effects.shadow.gradient.colors.stopPublished textProps.effects.shadow.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
textProps.effects.shadow.gradient.endXPublished textProps.effects.shadow.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.shadow.gradient.endYPublished textProps.effects.shadow.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.shadow.gradient.pivotXPublished textProps.effects.shadow.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.shadow.gradient.pivotYPublished textProps.effects.shadow.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.shadow.gradient.repeatPublished textProps.effects.shadow.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
textProps.effects.shadow.gradient.rotatePublished textProps.effects.shadow.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.shadow.gradient.startXPublished textProps.effects.shadow.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.shadow.gradient.startYPublished textProps.effects.shadow.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.shadow.gradient.typePublished textProps.effects.shadow.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
textProps.effects.shadow.gradient.endRadiusPublished textProps.effects.shadow.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.shadow.gradient.startRadiusPublished textProps.effects.shadow.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.shadow.gradient.centerXPublished textProps.effects.shadow.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.shadow.gradient.centerYPublished textProps.effects.shadow.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.shadow.gradient.startAnglePublished textProps.effects.shadow.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.shadow.offsetXPublished textProps.effects.shadow.offsetX option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.shadow.offsetYPublished textProps.effects.shadow.offsetY option.numberOptionalDefault——node22 · node24 · node26
textProps.effects.shadow.opacityPublished textProps.effects.shadow.opacity option.numberOptionalDefault——node22 · node24 · node26
textProps.fillGrouped fill color / gradient and draw opacity (see {@link resolveTextFill}).TextFillOptionalDefault——node22 · node24 · node26
textProps.fill.colorPublished textProps.fill.color option.stringOptionalDefault——node22 · node24 · node26
textProps.fill.gradientPublished textProps.fill.gradient option.gradientOptionalDefault——node22 · node24 · node26
textProps.fill.gradient.colorsPublished textProps.fill.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
textProps.fill.gradient.colors.colorPublished textProps.fill.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
textProps.fill.gradient.colors.stopPublished textProps.fill.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
textProps.fill.gradient.endXPublished textProps.fill.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
textProps.fill.gradient.endYPublished textProps.fill.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
textProps.fill.gradient.pivotXPublished textProps.fill.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
textProps.fill.gradient.pivotYPublished textProps.fill.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
textProps.fill.gradient.repeatPublished textProps.fill.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
textProps.fill.gradient.rotatePublished textProps.fill.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
textProps.fill.gradient.startXPublished textProps.fill.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
textProps.fill.gradient.startYPublished textProps.fill.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
textProps.fill.gradient.typePublished textProps.fill.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
textProps.fill.gradient.endRadiusPublished textProps.fill.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.fill.gradient.startRadiusPublished textProps.fill.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.fill.gradient.centerXPublished textProps.fill.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
textProps.fill.gradient.centerYPublished textProps.fill.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
textProps.fill.gradient.startAnglePublished textProps.fill.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
textProps.fill.opacityPublished textProps.fill.opacity option.numberOptionalDefault——node22 · node24 · node26
textProps.fontPublished textProps.font option.{ size?: number; family?: string; name?: string; path?: string; }OptionalDefault——node22 · node24 · node26
textProps.font.familyPublished textProps.font.family option.stringOptionalDefault——node22 · node24 · node26
textProps.font.namePublished textProps.font.name option.stringOptionalDefault——node22 · node24 · node26
textProps.font.pathPublished textProps.font.path option.stringOptionalDefault——node22 · node24 · node26
textProps.font.sizePublished textProps.font.size option.numberOptionalDefault——node22 · node24 · node26
textProps.fontFamilyPublished textProps.fontFamily option.DeprecatedstringOptionalDefault——node22 · node24 · node26
textProps.fontNamePublished textProps.fontName option.DeprecatedstringOptionalDefault——node22 · node24 · node26
textProps.fontPathPublished textProps.fontPath option.DeprecatedstringOptionalDefault——node22 · node24 · node26
textProps.fontSizePublished textProps.fontSize option.DeprecatednumberOptionalDefault——node22 · node24 · node26
textProps.glowPublished textProps.glow option.DeprecatedTextGlowStyleOptionalDefault——node22 · node24 · node26
textProps.glow.colorPublished textProps.glow.color option.stringOptionalDefault——node22 · node24 · node26
textProps.glow.gradientPublished textProps.glow.gradient option.gradientOptionalDefault——node22 · node24 · node26
textProps.glow.gradient.colorsPublished textProps.glow.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
textProps.glow.gradient.colors.colorPublished textProps.glow.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
textProps.glow.gradient.colors.stopPublished textProps.glow.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
textProps.glow.gradient.endXPublished textProps.glow.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
textProps.glow.gradient.endYPublished textProps.glow.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
textProps.glow.gradient.pivotXPublished textProps.glow.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
textProps.glow.gradient.pivotYPublished textProps.glow.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
textProps.glow.gradient.repeatPublished textProps.glow.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
textProps.glow.gradient.rotatePublished textProps.glow.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
textProps.glow.gradient.startXPublished textProps.glow.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
textProps.glow.gradient.startYPublished textProps.glow.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
textProps.glow.gradient.typePublished textProps.glow.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
textProps.glow.gradient.endRadiusPublished textProps.glow.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.glow.gradient.startRadiusPublished textProps.glow.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.glow.gradient.centerXPublished textProps.glow.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
textProps.glow.gradient.centerYPublished textProps.glow.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
textProps.glow.gradient.startAnglePublished textProps.glow.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
textProps.glow.intensityPublished textProps.glow.intensity option.numberOptionalDefault——node22 · node24 · node26
textProps.glow.opacityPublished textProps.glow.opacity option.numberOptionalDefault——node22 · node24 · node26
textProps.gradientPublished textProps.gradient option.DeprecatedgradientOptionalDefault——node22 · node24 · node26
textProps.gradient.colorsPublished textProps.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
textProps.gradient.colors.colorPublished textProps.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
textProps.gradient.colors.stopPublished textProps.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
textProps.gradient.endXPublished textProps.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
textProps.gradient.endYPublished textProps.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
textProps.gradient.pivotXPublished textProps.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
textProps.gradient.pivotYPublished textProps.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
textProps.gradient.repeatPublished textProps.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
textProps.gradient.rotatePublished textProps.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
textProps.gradient.startXPublished textProps.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
textProps.gradient.startYPublished textProps.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
textProps.gradient.typePublished textProps.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
textProps.gradient.endRadiusPublished textProps.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.gradient.startRadiusPublished textProps.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.gradient.centerXPublished textProps.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
textProps.gradient.centerYPublished textProps.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
textProps.gradient.startAnglePublished textProps.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
textProps.highlightPublished textProps.highlight option.DeprecatedTextHighlightStyleOptionalDefault——node22 · node24 · node26
textProps.highlight.colorPublished textProps.highlight.color option.stringOptionalDefault——node22 · node24 · node26
textProps.highlight.gradientPublished textProps.highlight.gradient option.gradientOptionalDefault——node22 · node24 · node26
textProps.highlight.gradient.colorsPublished textProps.highlight.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
textProps.highlight.gradient.colors.colorPublished textProps.highlight.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
textProps.highlight.gradient.colors.stopPublished textProps.highlight.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
textProps.highlight.gradient.endXPublished textProps.highlight.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
textProps.highlight.gradient.endYPublished textProps.highlight.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
textProps.highlight.gradient.pivotXPublished textProps.highlight.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
textProps.highlight.gradient.pivotYPublished textProps.highlight.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
textProps.highlight.gradient.repeatPublished textProps.highlight.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
textProps.highlight.gradient.rotatePublished textProps.highlight.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
textProps.highlight.gradient.startXPublished textProps.highlight.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
textProps.highlight.gradient.startYPublished textProps.highlight.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
textProps.highlight.gradient.typePublished textProps.highlight.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
textProps.highlight.gradient.endRadiusPublished textProps.highlight.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.highlight.gradient.startRadiusPublished textProps.highlight.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.highlight.gradient.centerXPublished textProps.highlight.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
textProps.highlight.gradient.centerYPublished textProps.highlight.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
textProps.highlight.gradient.startAnglePublished textProps.highlight.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
textProps.highlight.opacityPublished textProps.highlight.opacity option.numberOptionalDefault——node22 · node24 · node26
textProps.includeCharMetricsPublished textProps.includeCharMetrics option.booleanOptionalDefault—false truenode22 · node24 · node26
textProps.italicPublished textProps.italic option.DeprecatedbooleanOptionalDefault—false truenode22 · node24 · node26
textProps.layoutGrouped line height, spacing, and wrap bounds (see {@link resolveTextLayout}).TextLayoutOptionalDefault——node22 · node24 · node26
textProps.layout.letterSpacingPublished textProps.layout.letterSpacing option.numberOptionalDefault——node22 · node24 · node26
textProps.layout.lineHeightPublished textProps.layout.lineHeight option.numberOptionalDefault——node22 · node24 · node26
textProps.layout.maxHeightPublished textProps.layout.maxHeight option.numberOptionalDefault——node22 · node24 · node26
textProps.layout.maxWidthPublished textProps.layout.maxWidth option.numberOptionalDefault——node22 · node24 · node26
textProps.layout.wordSpacingPublished textProps.layout.wordSpacing option.numberOptionalDefault——node22 · node24 · node26
textProps.letterSpacingPublished textProps.letterSpacing option.DeprecatednumberOptionalDefault——node22 · node24 · node26
textProps.lineHeightPublished textProps.lineHeight option.DeprecatednumberOptionalDefault——node22 · node24 · node26
textProps.maxHeightPublished textProps.maxHeight option.DeprecatednumberOptionalDefault——node22 · node24 · node26
textProps.maxWidthPublished textProps.maxWidth option.DeprecatednumberOptionalDefault——node22 · node24 · node26
textProps.measurementCanvasPublished textProps.measurementCanvas option.{ width?: number; height?: number; }OptionalDefault——node22 · node24 · node26
textProps.measurementCanvas.heightPublished textProps.measurementCanvas.height option.numberOptionalDefault——node22 · node24 · node26
textProps.measurementCanvas.widthPublished textProps.measurementCanvas.width option.numberOptionalDefault——node22 · node24 · node26
textProps.opacityPublished textProps.opacity option.DeprecatednumberOptionalDefault——node22 · node24 · node26
textProps.overlinePublished textProps.overline option.DeprecatedTextLineDecorationOptionalDefault——node22 · node24 · node26
textProps.overline.colorPublished textProps.overline.color option.stringOptionalDefault——node22 · node24 · node26
textProps.overline.gradientPublished textProps.overline.gradient option.gradientOptionalDefault——node22 · node24 · node26
textProps.overline.gradient.colorsPublished textProps.overline.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
textProps.overline.gradient.colors.colorPublished textProps.overline.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
textProps.overline.gradient.colors.stopPublished textProps.overline.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
textProps.overline.gradient.endXPublished textProps.overline.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
textProps.overline.gradient.endYPublished textProps.overline.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
textProps.overline.gradient.pivotXPublished textProps.overline.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
textProps.overline.gradient.pivotYPublished textProps.overline.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
textProps.overline.gradient.repeatPublished textProps.overline.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
textProps.overline.gradient.rotatePublished textProps.overline.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
textProps.overline.gradient.startXPublished textProps.overline.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
textProps.overline.gradient.startYPublished textProps.overline.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
textProps.overline.gradient.typePublished textProps.overline.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
textProps.overline.gradient.endRadiusPublished textProps.overline.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.overline.gradient.startRadiusPublished textProps.overline.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.overline.gradient.centerXPublished textProps.overline.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
textProps.overline.gradient.centerYPublished textProps.overline.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
textProps.overline.gradient.startAnglePublished textProps.overline.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
textProps.overline.widthPublished textProps.overline.width option.numberOptionalDefault——node22 · node24 · node26
textProps.placementGrouped alignment, baseline, and rotation (see {@link resolveTextPlacement}).TextPlacementOptionalDefault——node22 · node24 · node26
textProps.placement.rotationPublished textProps.placement.rotation option.numberOptionalDefault——node22 · node24 · node26
textProps.placement.textAlignPublished textProps.placement.textAlign option.TextAlignModeOptionalDefault—
5 values
"center" "left" "right" "start" "end"
node22 · node24 · node26
textProps.placement.textBaselinePublished textProps.placement.textBaseline option.TextBaselineModeOptionalDefault—
6 values
"top" "bottom" "alphabetic" "hanging" "ideographic" "middle"
node22 · node24 · node26
textProps.rotationPublished textProps.rotation option.DeprecatednumberOptionalDefault——node22 · node24 · node26
textProps.shadowPublished textProps.shadow option.DeprecatedTextShadowStyleOptionalDefault——node22 · node24 · node26
textProps.shadow.blurPublished textProps.shadow.blur option.numberOptionalDefault——node22 · node24 · node26
textProps.shadow.colorPublished textProps.shadow.color option.stringOptionalDefault——node22 · node24 · node26
textProps.shadow.gradientPublished textProps.shadow.gradient option.gradientOptionalDefault——node22 · node24 · node26
textProps.shadow.gradient.colorsPublished textProps.shadow.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
textProps.shadow.gradient.colors.colorPublished textProps.shadow.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
textProps.shadow.gradient.colors.stopPublished textProps.shadow.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
textProps.shadow.gradient.endXPublished textProps.shadow.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
textProps.shadow.gradient.endYPublished textProps.shadow.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
textProps.shadow.gradient.pivotXPublished textProps.shadow.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
textProps.shadow.gradient.pivotYPublished textProps.shadow.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
textProps.shadow.gradient.repeatPublished textProps.shadow.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
textProps.shadow.gradient.rotatePublished textProps.shadow.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
textProps.shadow.gradient.startXPublished textProps.shadow.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
textProps.shadow.gradient.startYPublished textProps.shadow.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
textProps.shadow.gradient.typePublished textProps.shadow.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
textProps.shadow.gradient.endRadiusPublished textProps.shadow.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.shadow.gradient.startRadiusPublished textProps.shadow.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.shadow.gradient.centerXPublished textProps.shadow.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
textProps.shadow.gradient.centerYPublished textProps.shadow.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
textProps.shadow.gradient.startAnglePublished textProps.shadow.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
textProps.shadow.offsetXPublished textProps.shadow.offsetX option.numberOptionalDefault——node22 · node24 · node26
textProps.shadow.offsetYPublished textProps.shadow.offsetY option.numberOptionalDefault——node22 · node24 · node26
textProps.shadow.opacityPublished textProps.shadow.opacity option.numberOptionalDefault——node22 · node24 · node26
textProps.strikethroughPublished textProps.strikethrough option.DeprecatedTextLineDecorationOptionalDefault——node22 · node24 · node26
textProps.strikethrough.colorPublished textProps.strikethrough.color option.stringOptionalDefault——node22 · node24 · node26
textProps.strikethrough.gradientPublished textProps.strikethrough.gradient option.gradientOptionalDefault——node22 · node24 · node26
textProps.strikethrough.gradient.colorsPublished textProps.strikethrough.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
textProps.strikethrough.gradient.colors.colorPublished textProps.strikethrough.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
textProps.strikethrough.gradient.colors.stopPublished textProps.strikethrough.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
textProps.strikethrough.gradient.endXPublished textProps.strikethrough.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
textProps.strikethrough.gradient.endYPublished textProps.strikethrough.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
textProps.strikethrough.gradient.pivotXPublished textProps.strikethrough.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
textProps.strikethrough.gradient.pivotYPublished textProps.strikethrough.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
textProps.strikethrough.gradient.repeatPublished textProps.strikethrough.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
textProps.strikethrough.gradient.rotatePublished textProps.strikethrough.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
textProps.strikethrough.gradient.startXPublished textProps.strikethrough.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
textProps.strikethrough.gradient.startYPublished textProps.strikethrough.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
textProps.strikethrough.gradient.typePublished textProps.strikethrough.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
textProps.strikethrough.gradient.endRadiusPublished textProps.strikethrough.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.strikethrough.gradient.startRadiusPublished textProps.strikethrough.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.strikethrough.gradient.centerXPublished textProps.strikethrough.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
textProps.strikethrough.gradient.centerYPublished textProps.strikethrough.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
textProps.strikethrough.gradient.startAnglePublished textProps.strikethrough.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
textProps.strikethrough.widthPublished textProps.strikethrough.width option.numberOptionalDefault——node22 · node24 · node26
textProps.strokePublished textProps.stroke option.TextStrokeStyleOptionalDefault——node22 · node24 · node26
textProps.stroke.colorPublished textProps.stroke.color option.stringOptionalDefault——node22 · node24 · node26
textProps.stroke.gradientPublished textProps.stroke.gradient option.gradientOptionalDefault——node22 · node24 · node26
textProps.stroke.gradient.colorsPublished textProps.stroke.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
textProps.stroke.gradient.colors.colorPublished textProps.stroke.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
textProps.stroke.gradient.colors.stopPublished textProps.stroke.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
textProps.stroke.gradient.endXPublished textProps.stroke.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
textProps.stroke.gradient.endYPublished textProps.stroke.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
textProps.stroke.gradient.pivotXPublished textProps.stroke.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
textProps.stroke.gradient.pivotYPublished textProps.stroke.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
textProps.stroke.gradient.repeatPublished textProps.stroke.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
textProps.stroke.gradient.rotatePublished textProps.stroke.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
textProps.stroke.gradient.startXPublished textProps.stroke.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
textProps.stroke.gradient.startYPublished textProps.stroke.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
textProps.stroke.gradient.typePublished textProps.stroke.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
textProps.stroke.gradient.endRadiusPublished textProps.stroke.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.stroke.gradient.startRadiusPublished textProps.stroke.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.stroke.gradient.centerXPublished textProps.stroke.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
textProps.stroke.gradient.centerYPublished textProps.stroke.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
textProps.stroke.gradient.startAnglePublished textProps.stroke.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
textProps.stroke.opacityPublished textProps.stroke.opacity option.numberOptionalDefault——node22 · node24 · node26
textProps.stroke.stylePublished textProps.stroke.style option."solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"OptionalDefault—
6 values
"solid" "dashed" "dotted" "groove" "ridge" "double"
node22 · node24 · node26
textProps.stroke.widthPublished textProps.stroke.width option.numberOptionalDefault——node22 · node24 · node26
textProps.textPublished textProps.text option.stringRequiredDefaultRequired—node22 · node24 · node26
textProps.textAlignPublished textProps.textAlign option.DeprecatedTextAlignModeOptionalDefault—
5 values
"center" "left" "right" "start" "end"
node22 · node24 · node26
textProps.textBaselinePublished textProps.textBaseline option.DeprecatedTextBaselineModeOptionalDefault—
6 values
"top" "bottom" "alphabetic" "hanging" "ideographic" "middle"
node22 · node24 · node26
textProps.textOnCurvePublished textProps.textOnCurve option.DeprecatedTextCurveConfigOptionalDefault——node22 · node24 · node26
textProps.textOnCurve.baselineOffsetPublished textProps.textOnCurve.baselineOffset option.numberOptionalDefault——node22 · node24 · node26
textProps.textOnCurve.layoutModePublished textProps.textOnCurve.layoutMode option.CurvedTextLayoutModeOptionalDefault—"fit" "clamp" "override"node22 · node24 · node26
textProps.textOnCurve.radiusPublished textProps.textOnCurve.radius option.numberOptionalDefault——node22 · node24 · node26
textProps.textOnCurve.startAngleDegPublished textProps.textOnCurve.startAngleDeg option.numberOptionalDefault——node22 · node24 · node26
textProps.textOnCurve.sweepAnglePublished textProps.textOnCurve.sweepAngle option.numberRequiredDefaultRequired—node22 · node24 · node26
textProps.textOnCurve.upPublished textProps.textOnCurve.up option.booleanOptionalDefault—false truenode22 · node24 · node26
textProps.underlinePublished textProps.underline option.DeprecatedTextLineDecorationOptionalDefault——node22 · node24 · node26
textProps.underline.colorPublished textProps.underline.color option.stringOptionalDefault——node22 · node24 · node26
textProps.underline.gradientPublished textProps.underline.gradient option.gradientOptionalDefault——node22 · node24 · node26
textProps.underline.gradient.colorsPublished textProps.underline.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
textProps.underline.gradient.colors.colorPublished textProps.underline.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
textProps.underline.gradient.colors.stopPublished textProps.underline.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
textProps.underline.gradient.endXPublished textProps.underline.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
textProps.underline.gradient.endYPublished textProps.underline.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
textProps.underline.gradient.pivotXPublished textProps.underline.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
textProps.underline.gradient.pivotYPublished textProps.underline.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
textProps.underline.gradient.repeatPublished textProps.underline.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
textProps.underline.gradient.rotatePublished textProps.underline.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
textProps.underline.gradient.startXPublished textProps.underline.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
textProps.underline.gradient.startYPublished textProps.underline.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
textProps.underline.gradient.typePublished textProps.underline.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
textProps.underline.gradient.endRadiusPublished textProps.underline.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.underline.gradient.startRadiusPublished textProps.underline.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
textProps.underline.gradient.centerXPublished textProps.underline.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
textProps.underline.gradient.centerYPublished textProps.underline.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
textProps.underline.gradient.startAnglePublished textProps.underline.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
textProps.underline.widthPublished textProps.underline.width option.numberOptionalDefault——node22 · node24 · node26
textProps.wordSpacingPublished textProps.wordSpacing option.DeprecatednumberOptionalDefault——node22 · node24 · node26
textProps.xPublished textProps.x option.numberRequiredDefaultRequired—node22 · node24 · node26
textProps.yPublished textProps.y option.numberRequiredDefaultRequired—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

textProps.bold

Optional

Published textProps.bold option.

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

textProps.color

Optional

Published textProps.color option.

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

textProps.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

textProps.decorations.bold

Optional

Published textProps.decorations.bold option.

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

textProps.decorations.italic

Optional

Published textProps.decorations.italic option.

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

textProps.decorations.overline

Optional

Published textProps.decorations.overline option.

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

textProps.decorations.overline.gradient.repeat

Optional

Published textProps.decorations.overline.gradient.repeat option.

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

textProps.decorations.underline

Optional

Published textProps.decorations.underline option.

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

textProps.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

textProps.effects.glow

Optional

Published textProps.effects.glow option.

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

textProps.effects.glow.color

Optional

Published textProps.effects.glow.color option.

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

textProps.effects.glow.gradient.repeat

Optional

Published textProps.effects.glow.gradient.repeat option.

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

textProps.effects.highlight

Optional

Published textProps.effects.highlight option.

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

textProps.effects.highlight.gradient.repeat

Optional

Published textProps.effects.highlight.gradient.repeat option.

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

textProps.effects.shadow

Optional

Published textProps.effects.shadow option.

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

textProps.effects.shadow.gradient.repeat

Optional

Published textProps.effects.shadow.gradient.repeat option.

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

textProps.fill

Optional

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

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

textProps.fill.color

Optional

Published textProps.fill.color option.

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

textProps.fill.gradient

Optional

Published textProps.fill.gradient option.

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

textProps.fill.gradient.colors

Required

Published textProps.fill.gradient.colors option.

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

textProps.fill.gradient.endX

Optional

Published textProps.fill.gradient.endX option.

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

textProps.fill.gradient.endY

Optional

Published textProps.fill.gradient.endY option.

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

textProps.fill.gradient.repeat

Optional

Published textProps.fill.gradient.repeat option.

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

textProps.fill.gradient.type

Required

Published textProps.fill.gradient.type option.

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

textProps.fill.opacity

Optional

Published textProps.fill.opacity option.

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

textProps.font

Optional

Published textProps.font option.

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

textProps.font.family

Optional

Published textProps.font.family option.

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

textProps.font.name

Optional

Published textProps.font.name option.

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

textProps.font.path

Optional

Published textProps.font.path option.

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

textProps.font.size

Optional

Published textProps.font.size option.

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

textProps.fontFamily

Optional

Published textProps.fontFamily option.

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

textProps.fontName

Optional

Published textProps.fontName option.

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

textProps.fontPath

Optional

Published textProps.fontPath option.

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

textProps.fontSize

Optional

Published textProps.fontSize option.

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

textProps.glow

Optional

Published textProps.glow option.

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

textProps.glow.color

Optional

Published textProps.glow.color option.

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

textProps.glow.gradient

Optional

Published textProps.glow.gradient option.

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

textProps.glow.gradient.colors

Required

Published textProps.glow.gradient.colors option.

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

textProps.glow.gradient.endX

Optional

Published textProps.glow.gradient.endX option.

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

textProps.glow.gradient.endY

Optional

Published textProps.glow.gradient.endY option.

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

textProps.glow.gradient.repeat

Optional

Published textProps.glow.gradient.repeat option.

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

textProps.glow.gradient.type

Required

Published textProps.glow.gradient.type option.

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

textProps.glow.intensity

Optional

Published textProps.glow.intensity option.

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

textProps.glow.opacity

Optional

Published textProps.glow.opacity option.

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

textProps.gradient

Optional

Published textProps.gradient option.

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

textProps.gradient.colors

Required

Published textProps.gradient.colors option.

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

textProps.gradient.colors.stop

Required

Published textProps.gradient.colors.stop option.

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

textProps.gradient.endX

Optional

Published textProps.gradient.endX option.

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

textProps.gradient.endY

Optional

Published textProps.gradient.endY option.

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

textProps.gradient.pivotX

Optional

Published textProps.gradient.pivotX option.

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

textProps.gradient.pivotY

Optional

Published textProps.gradient.pivotY option.

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

textProps.gradient.repeat

Optional

Published textProps.gradient.repeat option.

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

textProps.gradient.rotate

Optional

Published textProps.gradient.rotate option.

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

textProps.gradient.startX

Optional

Published textProps.gradient.startX option.

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

textProps.gradient.startY

Optional

Published textProps.gradient.startY option.

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

textProps.gradient.type

Required

Published textProps.gradient.type option.

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

textProps.gradient.endRadius

Optional

Published textProps.gradient.endRadius option.

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

textProps.gradient.centerX

Optional

Published textProps.gradient.centerX option.

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

textProps.gradient.centerY

Optional

Published textProps.gradient.centerY option.

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

textProps.highlight

Optional

Published textProps.highlight option.

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

textProps.highlight.color

Optional

Published textProps.highlight.color option.

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

textProps.highlight.gradient

Optional

Published textProps.highlight.gradient option.

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

textProps.highlight.gradient.repeat

Optional

Published textProps.highlight.gradient.repeat option.

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

textProps.highlight.opacity

Optional

Published textProps.highlight.opacity option.

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

textProps.includeCharMetrics

Optional

Published textProps.includeCharMetrics option.

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

textProps.italic

Optional

Published textProps.italic option.

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

textProps.layout

Optional

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

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

textProps.layout.lineHeight

Optional

Published textProps.layout.lineHeight option.

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

textProps.layout.maxHeight

Optional

Published textProps.layout.maxHeight option.

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

textProps.layout.maxWidth

Optional

Published textProps.layout.maxWidth option.

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

textProps.layout.wordSpacing

Optional

Published textProps.layout.wordSpacing option.

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

textProps.letterSpacing

Optional

Published textProps.letterSpacing option.

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

textProps.lineHeight

Optional

Published textProps.lineHeight option.

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

textProps.maxHeight

Optional

Published textProps.maxHeight option.

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

textProps.maxWidth

Optional

Published textProps.maxWidth option.

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

textProps.measurementCanvas

Optional

Published textProps.measurementCanvas option.

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

textProps.opacity

Optional

Published textProps.opacity option.

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

textProps.overline

Optional

Published textProps.overline option.

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

textProps.overline.color

Optional

Published textProps.overline.color option.

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

textProps.overline.gradient

Optional

Published textProps.overline.gradient option.

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

textProps.overline.gradient.repeat

Optional

Published textProps.overline.gradient.repeat option.

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

textProps.overline.gradient.type

Required

Published textProps.overline.gradient.type option.

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

textProps.overline.width

Optional

Published textProps.overline.width option.

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

textProps.placement

Optional

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

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

textProps.placement.rotation

Optional

Published textProps.placement.rotation option.

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

textProps.placement.textAlign

Optional

Published textProps.placement.textAlign option.

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

textProps.placement.textBaseline

Optional

Published textProps.placement.textBaseline option.

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

textProps.rotation

Optional

Published textProps.rotation option.

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

textProps.shadow

Optional

Published textProps.shadow option.

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

textProps.shadow.blur

Optional

Published textProps.shadow.blur option.

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

textProps.shadow.color

Optional

Published textProps.shadow.color option.

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

textProps.shadow.gradient

Optional

Published textProps.shadow.gradient option.

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

textProps.shadow.gradient.colors

Required

Published textProps.shadow.gradient.colors option.

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

textProps.shadow.gradient.repeat

Optional

Published textProps.shadow.gradient.repeat option.

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

textProps.shadow.gradient.type

Required

Published textProps.shadow.gradient.type option.

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

textProps.shadow.offsetX

Optional

Published textProps.shadow.offsetX option.

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

textProps.shadow.offsetY

Optional

Published textProps.shadow.offsetY option.

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

textProps.shadow.opacity

Optional

Published textProps.shadow.opacity option.

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

textProps.strikethrough

Optional

Published textProps.strikethrough option.

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

textProps.strikethrough.gradient.repeat

Optional

Published textProps.strikethrough.gradient.repeat option.

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

textProps.stroke

Optional

Published textProps.stroke option.

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

textProps.stroke.color

Optional

Published textProps.stroke.color option.

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

textProps.stroke.gradient

Optional

Published textProps.stroke.gradient option.

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

textProps.stroke.gradient.colors

Required

Published textProps.stroke.gradient.colors option.

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

textProps.stroke.gradient.repeat

Optional

Published textProps.stroke.gradient.repeat option.

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

textProps.stroke.gradient.type

Required

Published textProps.stroke.gradient.type option.

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

textProps.stroke.opacity

Optional

Published textProps.stroke.opacity option.

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

textProps.stroke.style

Optional

Published textProps.stroke.style option.

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

textProps.stroke.width

Optional

Published textProps.stroke.width option.

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

textProps.text

Required

Published textProps.text option.

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

textProps.textAlign

Optional

Published textProps.textAlign option.

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

textProps.textBaseline

Optional

Published textProps.textBaseline option.

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

textProps.textOnCurve

Optional

Published textProps.textOnCurve option.

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

textProps.textOnCurve.layoutMode

Optional

Published textProps.textOnCurve.layoutMode option.

Type
CurvedTextLayoutMode
Default
—
Allowed
"fit" "clamp" "override"
Runtime
node22, node24, node26

textProps.textOnCurve.radius

Optional

Published textProps.textOnCurve.radius option.

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

textProps.textOnCurve.up

Optional

Published textProps.textOnCurve.up option.

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

textProps.underline

Optional

Published textProps.underline option.

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

textProps.underline.color

Optional

Published textProps.underline.color option.

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

textProps.underline.gradient

Optional

Published textProps.underline.gradient option.

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

textProps.underline.gradient.repeat

Optional

Published textProps.underline.gradient.repeat option.

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

textProps.underline.width

Optional

Published textProps.underline.width option.

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

textProps.wordSpacing

Optional

Published textProps.wordSpacing option.

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

textProps.x

Required

Published textProps.x option.

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

textProps.y

Required

Published textProps.y option.

Type
number
Default
Required
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

TextProperties: TextProperties
  • textstring
  • xnumber
  • ynumber
  • font?
    __type: { size?: number; family?: string; name?: string; path?: string; }
    • size?number
    • family?string
    • name?string
    • path?string
  • fontSize?number
  • fontFamily?string
  • fontName?string
  • fontPath?string
  • bold?boolean
  • italic?boolean
  • decorations?
    TextDecorations: TextDecorations
    • underline?
      TextLineDecoration
      • variant 1false
      • variant 2true
      • 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[]; }
        • width?number
    • overline?
      TextLineDecoration
      • variant 1false
      • variant 2true
      • 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[]; }
        • width?number
    • strikethrough?
      TextLineDecoration
      • variant 1false
      • variant 2true
      • 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[]; }
        • width?number
    • bold?boolean
    • italic?boolean
  • effects?
    TextEffects: TextEffects
    • 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"
          • colorsGradientStop[]
        • 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"
          • colorsGradientStop[]
        • 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
          • colorsGradientStop[]
      • opacity?number
    • 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"
          • colorsGradientStop[]
        • 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"
          • colorsGradientStop[]
        • 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
          • colorsGradientStop[]
      • intensity?number
      • opacity?number
    • 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"
          • colorsGradientStop[]
        • 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"
          • colorsGradientStop[]
        • 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
          • colorsGradientStop[]
      • offsetX?number
      • offsetY?number
      • blur?number
      • opacity?number
  • underline?
    TextLineDecoration
    • variant 1false
    • variant 2true
    • variant 3
      __type: { color?: string; gradient?: gradient; width?: 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"
          • colorsGradientStop[]
        • 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"
          • colorsGradientStop[]
        • 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
          • colorsGradientStop[]
      • width?number
  • overline?
    TextLineDecoration
    • variant 1false
    • variant 2true
    • variant 3
      __type: { color?: string; gradient?: gradient; width?: 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"
          • colorsGradientStop[]
        • 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"
          • colorsGradientStop[]
        • 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
          • colorsGradientStop[]
      • width?number
  • strikethrough?
    TextLineDecoration
    • variant 1false
    • variant 2true
    • variant 3
      __type: { color?: string; gradient?: gradient; width?: 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"
          • colorsGradientStop[]
        • 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"
          • colorsGradientStop[]
        • 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
          • colorsGradientStop[]
      • width?number
  • 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"
          • variant 1"repeat"
          • variant 2"reflect"
          • variant 3"no-repeat"
        • colors
          GradientStop[]
          • variant 1GradientStop
      • variant 2
        __type: { type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }
        • type"radial"
        • startX?number
        • startY?number
        • startRadius?number
        • endX?number
        • endY?number
        • endRadius?number
        • rotate?number
        • pivotX?number
        • pivotY?number
        • repeat?
          "repeat" | "reflect" | "no-repeat"
          • variant 1"repeat"
          • variant 2"reflect"
          • variant 3"no-repeat"
        • colors
          GradientStop[]
          • variant 1GradientStop
      • variant 3
        __type: { type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
        • type"conic"
        • centerX?number
        • centerY?number
        • startAngle?number
        • rotate?number
        • pivotX?number
        • pivotY?number
        • colors
          GradientStop[]
          • variant 1GradientStop
    • opacity?number
  • 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"
          • variant 1"repeat"
          • variant 2"reflect"
          • variant 3"no-repeat"
        • colors
          GradientStop[]
          • variant 1GradientStop
      • variant 2
        __type: { type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }
        • type"radial"
        • startX?number
        • startY?number
        • startRadius?number
        • endX?number
        • endY?number
        • endRadius?number
        • rotate?number
        • pivotX?number
        • pivotY?number
        • repeat?
          "repeat" | "reflect" | "no-repeat"
          • variant 1"repeat"
          • variant 2"reflect"
          • variant 3"no-repeat"
        • colors
          GradientStop[]
          • variant 1GradientStop
      • variant 3
        __type: { type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
        • type"conic"
        • centerX?number
        • centerY?number
        • startAngle?number
        • rotate?number
        • pivotX?number
        • pivotY?number
        • colors
          GradientStop[]
          • variant 1GradientStop
    • intensity?number
    • opacity?number
  • 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"
          • variant 1"repeat"
          • variant 2"reflect"
          • variant 3"no-repeat"
        • colors
          GradientStop[]
          • variant 1GradientStop
      • variant 2
        __type: { type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }
        • type"radial"
        • startX?number
        • startY?number
        • startRadius?number
        • endX?number
        • endY?number
        • endRadius?number
        • rotate?number
        • pivotX?number
        • pivotY?number
        • repeat?
          "repeat" | "reflect" | "no-repeat"
          • variant 1"repeat"
          • variant 2"reflect"
          • variant 3"no-repeat"
        • colors
          GradientStop[]
          • variant 1GradientStop
      • variant 3
        __type: { type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
        • type"conic"
        • centerX?number
        • centerY?number
        • startAngle?number
        • rotate?number
        • pivotX?number
        • pivotY?number
        • colors
          GradientStop[]
          • variant 1GradientStop
    • offsetX?number
    • offsetY?number
    • blur?number
    • opacity?number
  • layout?
    TextLayout: TextLayout
    • lineHeight?number
    • letterSpacing?number
    • wordSpacing?number
    • maxWidth?number
    • maxHeight?number
  • placement?
    TextPlacement: TextPlacement
    • textAlign?
      TextAlignMode
      • variant 1"center"
      • variant 2"left"
      • variant 3"right"
      • variant 4"start"
      • variant 5"end"
    • textBaseline?
      TextBaselineMode
      • variant 1"top"
      • variant 2"bottom"
      • variant 3"alphabetic"
      • variant 4"hanging"
      • variant 5"ideographic"
      • variant 6"middle"
    • rotation?number
  • 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"
          • variant 1"repeat"
          • variant 2"reflect"
          • variant 3"no-repeat"
        • colors
          GradientStop[]
          • variant 1GradientStop
      • variant 2
        __type: { type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }
        • type"radial"
        • startX?number
        • startY?number
        • startRadius?number
        • endX?number
        • endY?number
        • endRadius?number
        • rotate?number
        • pivotX?number
        • pivotY?number
        • repeat?
          "repeat" | "reflect" | "no-repeat"
          • variant 1"repeat"
          • variant 2"reflect"
          • variant 3"no-repeat"
        • colors
          GradientStop[]
          • variant 1GradientStop
      • variant 3
        __type: { type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
        • type"conic"
        • centerX?number
        • centerY?number
        • startAngle?number
        • rotate?number
        • pivotX?number
        • pivotY?number
        • colors
          GradientStop[]
          • variant 1GradientStop
    • opacity?number
  • 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"
  • textBaseline?
    TextBaselineMode
    • variant 1"top"
    • variant 2"bottom"
    • variant 3"alphabetic"
    • variant 4"hanging"
    • variant 5"ideographic"
    • variant 6"middle"
  • 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"
      • colors
        GradientStop[]
        • variant 1
          GradientStop: GradientStop
          • stopnumber
          • colorstring
    • variant 2
      __type: { type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }
      • type"radial"
      • startX?number
      • startY?number
      • startRadius?number
      • endX?number
      • endY?number
      • endRadius?number
      • rotate?number
      • pivotX?number
      • pivotY?number
      • repeat?
        "repeat" | "reflect" | "no-repeat"
        • variant 1"repeat"
        • variant 2"reflect"
        • variant 3"no-repeat"
      • colors
        GradientStop[]
        • variant 1
          GradientStop: GradientStop
          • stopnumber
          • colorstring
    • variant 3
      __type: { type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
      • type"conic"
      • centerX?number
      • centerY?number
      • startAngle?number
      • rotate?number
      • pivotX?number
      • pivotY?number
      • colors
        GradientStop[]
        • variant 1
          GradientStop: GradientStop
          • stopnumber
          • colorstring
  • 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"
          • variant 1"repeat"
          • variant 2"reflect"
          • variant 3"no-repeat"
        • colors
          GradientStop[]
          • variant 1GradientStop
      • variant 2
        __type: { type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }
        • type"radial"
        • startX?number
        • startY?number
        • startRadius?number
        • endX?number
        • endY?number
        • endRadius?number
        • rotate?number
        • pivotX?number
        • pivotY?number
        • repeat?
          "repeat" | "reflect" | "no-repeat"
          • variant 1"repeat"
          • variant 2"reflect"
          • variant 3"no-repeat"
        • colors
          GradientStop[]
          • variant 1GradientStop
      • variant 3
        __type: { type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
        • type"conic"
        • centerX?number
        • centerY?number
        • startAngle?number
        • rotate?number
        • pivotX?number
        • pivotY?number
        • colors
          GradientStop[]
          • variant 1GradientStop
    • 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"
  • textOnCurve?
    TextCurveConfig: TextCurveConfig
    • sweepAnglenumber
    • radius?number
    • up?boolean
    • layoutMode?
      CurvedTextLayoutMode
      • variant 1"fit"
      • variant 2"clamp"
      • variant 3"override"
    • baselineOffset?number
    • startAngleDeg?number
  • includeCharMetrics?boolean
  • measurementCanvas?
    __type: { width?: number; height?: number; }
    • width?number
    • height?number
PainterAssetRefsOptions: PainterAssetRefsOptions
  • resolveAssetRefs?boolean

Return value

Promise<TextMetrics>

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

Errors

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

Limits

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

Related APIs

No explicit related API metadata.

Next steps

ApexPainter._detectAPI member · node · CURRENT

Published ApexPainter._detect property.

ApexPainter._outputAPI member · node · CURRENT

Published ApexPainter._output property.

ApexPainter._outputFormatAPI member · node · CURRENT

Published ApexPainter._outputFormat property.

ApexPainter._path2dAPI member · node · CURRENT

Published ApexPainter._path2d property.