Skip to content

Vizzu


Vizzu / animcontrol / AnimControl

Class: AnimControl

Control object for animation.

Accessors

direction

Get Signature

get direction(): "reverse" | "normal"

Getting the play direction of the animation.

Returns

"reverse" | "normal"

Set Signature

set direction(value): void

Setting the play direction of the animation.

Parameters

value

"reverse" | "normal"

Returns

void


playState

Get Signature

get playState(): "paused" | "running"

Getting the playback state of the animation.

Returns

"paused" | "running"

Set Signature

set playState(value): void

Setting the playback state of the animation.

Parameters

value

"paused" | "running"

Returns

void


position

Get Signature

get position(): number

Getting the position of the animation.

Returns

number

Set Signature

set position(value): void

Setting the position of the animation.

Parameters

value

number

Returns

void


speed

Get Signature

get speed(): number

Getting the playback speed of the animation.

Returns

number

Set Signature

set speed(value): void

Setting the playback speed of the animation. It is 1.0 by default. Negative values are considered 0.

Parameters

value

number

Returns

void

Methods

cancel()

cancel(): this

Cancels the animation, will reject the animation promise.

Returns

this


~~pause()~~

pause(): this

Returns

this

Deprecated

Pauses the controlled animation.


~~play()~~

play(): this

Returns

this

Deprecated

Plays/resumes playing of the controlled animation.


~~reverse()~~

reverse(): this

Returns

this

Deprecated

Changes the direction of the controlled animation to reverse.


seek()

seek(value): this

Seeks the animation to the position specified by time or progress percentage. Seeking the animation to the end position while the animation is paused will not trigger the animation complete promise to resolve.

Parameters

value

Position

Returns

this


stop()

stop(): this

Stops the current animation seeking it back to its start position.

Returns

this


store()

store(): CAnimation

Returns a reference to the actual animation for further reuse.

Returns

CAnimation