Winter Cardinal UI - v0.442.0 / DAnimationOnOptions

Interface: DAnimationOnOptions<EMITTER>

DAnimation “on” options.

Type parameters

Name
EMITTER

Hierarchy

• Partial<DAnimationEvents<EMITTER>>

• DOnOptions

  ↳ DAnimationOnOptions

Table of contents

Methods

• end
• start
• stop
• time

Methods

end

▸ end(isReverse, emitter): void

Triggered when an animation ends.

Parameters

Name	Type	Description
isReverse	boolean	true if an animation is playing in reverse
emitter	EMITTER	an emitter

Returns

void

Inherited from

Partial.end

Defined in

src/main/typescript/wcardinal/ui/d-animation.ts:84

---

start

▸ start(isReverse, emitter): void

Triggered when an animation starts.

Parameters

Name	Type	Description
isReverse	boolean	true if an animation is playing in reverse
emitter	EMITTER	an emitter

Returns

void

Inherited from

Partial.start

Defined in

src/main/typescript/wcardinal/ui/d-animation.ts:66

---

stop

▸ stop(isReverse, emitter): void

Triggered when an animation stops.

Parameters

Name	Type	Description
isReverse	boolean	true if an animation is playing in reverse
emitter	EMITTER	an emitter

Returns

void

Inherited from

Partial.stop

Defined in

src/main/typescript/wcardinal/ui/d-animation.ts:92

---

time

▸ time(time, isReverse, elapsedTime, emitter): void

Triggered constantly when an animation is on a run.

Parameters

Name	Type	Description
time	number	a timing value in a range [0, 1]
isReverse	boolean	true if an animation is playing in reverse
elapsedTime	number	an elapsed time since an animation has started
emitter	EMITTER	an emitter

Returns

void

Inherited from

Partial.time

Defined in

src/main/typescript/wcardinal/ui/d-animation.ts:76

Edit this page.