Skip to main content

Interface: WriteOptions

Defined in: src/animation/creation/Create.ts:509

Extends​

Properties​

duration?​

optional duration: number

Defined in: src/animation/Animation.ts:16

Duration of the animation in seconds (default: 1)

Inherited from​

AnimationOptions.duration


lagRatio?​

optional lagRatio: number

Defined in: src/animation/creation/Create.ts:511

Stagger between characters, default 0.05


rateFunc?​

optional rateFunc: RateFunction

Defined in: src/animation/Animation.ts:18

Rate function controlling the animation's pacing (default: smooth)

Inherited from​

AnimationOptions.rateFunc


remover?​

optional remover: boolean

Defined in: src/animation/creation/Create.ts:515

Remove after animation, default false


reverse?​

optional reverse: boolean

Defined in: src/animation/creation/Create.ts:513

Write in reverse (right to left), default false


shift?​

optional shift: [number, number, number]

Defined in: src/animation/Animation.ts:20

Shift direction for fade animations

Inherited from​

AnimationOptions.shift


strokeRatio?​

optional strokeRatio: number

Defined in: src/animation/creation/Create.ts:517

Ratio of animation time spent on stroke drawing vs cross-fade (default 0.7 = 70% stroke, 30% crossfade)


useSkeletonStroke?​

optional useSkeletonStroke: boolean

Defined in: src/animation/creation/Create.ts:524

When true, the Write animation uses the glyph's skeleton (medial axis) for stroke drawing, producing natural center-line pen strokes instead of perimeter outlines. Requires glyphs to be loaded with useSkeletonStroke: true. Default: false (uses outline strokes).