interface export
TextProperties
Published interface export TextProperties.
apexify.jsCURRENTnode22node24node26
Source: lib-next/types/text.ts (opens in a new tab)Signature
export interface TextProperties {
text: string;
x: number;
y: number;
font?: {
size?: number;
family?: string;
name?: string;
path?: string;
};
/** @deprecated Use `font.size` */
fontSize?: number;
/** @deprecated Use `font.family` */
fontFamily?: string;
/** @deprecated Use `font.name` */
fontName?: string;
/** @deprecated Use `font.path` */
fontPath?: string;
/** @deprecated Use `decorations.bold` */
bold?: boolean;
/** @deprecated Use `decorations.italic` */
italic?: boolean;
/**
* 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}).
*/
decorations?: TextDecorations;
/**
* Grouped highlight, glow, and shadow. When set, entries override the legacy flat fields
* (see {@link resolveTextEffects}).
*/
effects?: TextEffects;
/** @deprecated Prefer `decorations.underline` */
underline?: TextLineDecoration;
/** @deprecated Prefer `decorations.overline` */
overline?: TextLineDecoration;
/** @deprecated Prefer `decorations.strikethrough` */
strikethrough?: TextLineDecoration;
/** @deprecated Prefer `effects.highlight` */
highlight?: TextHighlightStyle;
/** @deprecated Prefer `effects.glow` */
glow?: TextGlowStyle;
/** @deprecated Prefer `effects.shadow` */
shadow?: TextShadowStyle;
/**
* Grouped line height, spacing, and wrap bounds (see {@link resolveTextLayout}).
*/
layout?: TextLayout;
/**
* Grouped alignment, baseline, and rotation (see {@link resolveTextPlacement}).
*/
placement?: TextPlacement;
/**
* Grouped fill color / gradient and draw opacity (see {@link resolveTextFill}).
*/
fill?: TextFill;
/** @deprecated Prefer `layout.lineHeight` */
lineHeight?: number;
/** @deprecated Prefer `layout.letterSpacing` */
letterSpacing?: number;
/** @deprecated Prefer `layout.wordSpacing` */
wordSpacing?: number;
/** @deprecated Prefer `layout.maxWidth` */
maxWidth?: number;
/** @deprecated Prefer `layout.maxHeight` */
maxHeight?: number;
/** @deprecated Prefer `placement.textAlign` */
textAlign?: TextAlignMode;
/** @deprecated Prefer `placement.textBaseline` */
textBaseline?: TextBaselineMode;
/** @deprecated Prefer `placement.rotation` */
rotation?: number;
/** @deprecated Prefer `fill.color` */
color?: string;
/** @deprecated Prefer `fill.gradient` */
gradient?: gradient;
/** @deprecated Prefer `fill.opacity` */
opacity?: number;
stroke?: TextStrokeStyle;
/** @deprecated Prefer a shared name — kept as the canonical field; shape matches {@link TextCurveConfig}. */
textOnCurve?: TextCurveConfig;
includeCharMetrics?: boolean;
measurementCanvas?: {
width?: number;
height?: number;
};
}Related APIs
No explicit related API metadata.