Class: TypeWithCursor
Defined in: src/animation/creation/TypeWithCursor.ts:95
TypeWithCursor - Types text character by character with a blinking cursor
Works with Text mobjects that support getText/setText methods. Displays a blinking cursor at the end of the typed text.
Example
const text = new Text({ text: 'Hello World' });
scene.play(typeWithCursor(text, { typingSpeed: 15 }));
Extends
Constructors
Constructor
new TypeWithCursor(
mobject,options):TypeWithCursor
Defined in: src/animation/creation/TypeWithCursor.ts:120
Parameters
mobject
options
Returns
TypeWithCursor
Overrides
Properties
_currentCharCount
protected_currentCharCount:number=0
Defined in: src/animation/creation/TypeWithCursor.ts:112
Currently displayed character count (excluding cursor)
_cursorVisible
protected_cursorVisible:boolean=true
Defined in: src/animation/creation/TypeWithCursor.ts:114
Track cursor visibility for blinking
_fullText
protected_fullText:string=''
Defined in: src/animation/creation/TypeWithCursor.ts:110
Full text to type
_hasBegun
protected_hasBegun:boolean=false
Defined in: src/animation/Animation.ts:49
Track if begin() has been called
Inherited from
_isFinished
protected_isFinished:boolean=false
Defined in: src/animation/Animation.ts:46
Whether the animation has finished
Inherited from
_lastCursorToggleTime
protected_lastCursorToggleTime:number=0
Defined in: src/animation/creation/TypeWithCursor.ts:116
Last cursor toggle time
_originalColor
protected_originalColor:string=''
Defined in: src/animation/creation/TypeWithCursor.ts:118
Original text color for highlighting
_startTime
protected_startTime:number=null
Defined in: src/animation/Animation.ts:43
Time when the animation started (set by Timeline)
Inherited from
cursorBlinkRate
protectedreadonlycursorBlinkRate:number
Defined in: src/animation/creation/TypeWithCursor.ts:99
Cursor blink rate in blinks per second
cursorBlinks
protectedreadonlycursorBlinks:boolean
Defined in: src/animation/creation/TypeWithCursor.ts:103
Whether cursor blinks during typing
cursorChar
protectedreadonlycursorChar:string
Defined in: src/animation/creation/TypeWithCursor.ts:97
Cursor character
duration
readonlyduration:number
Defined in: src/animation/Animation.ts:37
Duration of the animation in seconds
Inherited from
hideCursorOnComplete
protectedreadonlyhideCursorOnComplete:boolean
Defined in: src/animation/creation/TypeWithCursor.ts:105
Whether to hide cursor on complete
highlightColor?
protectedreadonlyoptionalhighlightColor:string
Defined in: src/animation/creation/TypeWithCursor.ts:107
Highlight color for typed text
mobject
readonlymobject:Mobject
Defined in: src/animation/Animation.ts:34
The mobject being animated
Inherited from
rateFunc
readonlyrateFunc:RateFunction
Defined in: src/animation/Animation.ts:40
Rate function controlling the animation's pacing
Inherited from
remover
remover:
boolean=false
Defined in: src/animation/Animation.ts:55
If true, the scene will remove this mobject after the animation finishes. Used by FadeOut (like Python manim's remover=True).
Inherited from
typingSpeed
protectedreadonlytypingSpeed:number
Defined in: src/animation/creation/TypeWithCursor.ts:101
Characters per second
Accessors
startTime
Get Signature
get startTime():
number
Defined in: src/animation/Animation.ts:236
Get the start time of this animation (set by Timeline)
Returns
number
Set Signature
set startTime(
time):void
Defined in: src/animation/Animation.ts:243
Set the start time of this animation (used by Timeline)
Parameters
time
number
Returns
void
Inherited from
Methods
_calculateDuration()
protected_calculateDuration():number
Defined in: src/animation/creation/TypeWithCursor.ts:138
Get the calculated duration based on text length
Returns
number
begin()
begin():
void
Defined in: src/animation/creation/TypeWithCursor.ts:142
Called when the animation starts. Subclasses can override to set up initial state. On the very first call, captures a snapshot of the mobject so that reset() can restore it for clean backward seeking.
Returns
void
Overrides
cleanUpFromScene()
cleanUpFromScene(
scene):void
Defined in: src/animation/Animation.ts:141
Hook called by Scene after the animation finishes, before the next play().
Default: removes mobject if remover is set (FadeOut, Write({remover:true})).
Override for animations that need to mutate scene membership — e.g.
ReplacementTransform swaps source for target.
Parameters
scene
AnimationScene
Returns
void
Inherited from
finish()
finish():
void
Defined in: src/animation/creation/TypeWithCursor.ts:205
Called when the animation ends. Subclasses can override to clean up or finalize state.
Returns
void
Overrides
getSubAlpha()
protectedgetSubAlpha(alpha,index,count,lagRatio):number
Defined in: src/animation/Animation.ts:161
Manim CE's get_sub_alpha: remaps a global progress alpha into the
local progress of family member index (of count) under a lagRatio
stagger. With lagRatio <= 0 (or a single member), every member tracks
alpha directly. Subclasses that stagger across a mobject's family
(e.g. Create) should index this by familyMembersWithPoints(), never by
rendering-layer primitives.
Parameters
alpha
number
index
number
count
number
lagRatio
number
Returns
number
Inherited from
interpolate()
interpolate(
alpha):void
Defined in: src/animation/creation/TypeWithCursor.ts:165
Apply the animation at a given progress value.
Parameters
alpha
number
Progress from 0 (start) to 1 (end)
Returns
void
Overrides
isFinished()
isFinished():
boolean
Defined in: src/animation/Animation.ts:197
Check if the animation has finished
Returns
boolean
Inherited from
reset()
reset():
void
Defined in: src/animation/Animation.ts:206
Reset the animation to its initial state. Restores the mobject to its pre-animation visual state so that re-seeking (especially backward) produces correct results.
Returns
void
Inherited from
update()
update(
_dt,currentTime):void
Defined in: src/animation/Animation.ts:174
Update the animation for the current frame.
Parameters
_dt
number
Time delta since last frame (unused, but available for subclasses)
currentTime
number
Current time in the timeline
Returns
void