Class Animation

Represents an Animation of an Element

Remarks

Animations can be created by calling Element.animation on any Element.

See Animations for more information.

Hierarchy (View Summary)

Lightning.EventEmitter<Lightning.types.Animation.EventMap>
- Animation

Index

Constructors

constructor

new Animation(
    manager: AnimationManager,
    settings: Lightning.types.AnimationSettings,
    element: Lightning.Element<
        Lightning.Element.TemplateSpecLoose,
        Lightning.Element.TypeConfigLoose,
    >,
): Lightning.types.Animation
Constructor
Parameters
- manager: AnimationManager
- settings: Lightning.types.AnimationSettings
- element: Lightning.Element<
  Lightning.Element.TemplateSpecLoose,
  Lightning.Element.TypeConfigLoose,
  >
Returns Lightning.types.Animation
Overrides EventEmitter.constructor
- Defined in animation/Animation.d.mts:121

Properties

`Readonly`manager

manager: AnimationManager

Animation manager

`Static`STATES

STATES: { FINISHED: 4; IDLE: 0; PAUSED: 5; PLAYING: 1; STOPPED: 3; STOPPING: 2 }

Animation State Enum

Type declaration

FINISHED: 4
Animation has finished playing (uninterrupted from from start to finish)
IDLE: 0
Animation has never been played
PAUSED: 5
Animation is paused

Remarks
Entered by a call to Animation.pause while the animation is PLAYING.
PLAYING: 1
Animation is currently playing

Remarks
Entered by a call to Animation.play
STOPPED: 3
Animation has finished its stop animation (if there was one)
STOPPING: 2
Animation is currently executing its stop animation

Remarks
The stop animation is determined by stopMethod.

Entered by a call to Animation.stop

Accessors

delayLeft

get delayLeft(): number
Gets the amount of delay left (in seconds) before the animation starts

Returns number
- Defined in animation/Animation.d.mts:225

element

get element(): Lightning.Element<
Lightning.Element.TemplateSpecLoose,
Lightning.Element.TypeConfigLoose,
>
Gets the Element that is being animated

Returns Lightning.Element<
Lightning.Element.TemplateSpecLoose,
Lightning.Element.TypeConfigLoose,
>
- Defined in animation/Animation.d.mts:230

frame

get frame(): number
Gets the current frame number of the animation expressed in 60fps

Returns number
- Defined in animation/Animation.d.mts:235

p

get p(): number
Gets the current progress point

Returns number
Remarks
This is always a value betwen 0.0 and 1.0
- Defined in animation/Animation.d.mts:220

settings

get settings(): Lightning.types.AnimationSettings
Gets the settings for this animation

Returns Lightning.types.AnimationSettings
- Defined in animation/Animation.d.mts:240

state

get state(): State
Gets the current state of the animation

Returns State
Remarks
See Animation.STATES for a description of each state
- Defined in animation/Animation.d.mts:212

Methods

emit

emit<EventName extends keyof Lightning.types.Animation.EventMap>(
name: EventName,
...args: HandlerParameters<Lightning.types.Animation.EventMap[EventName]>,
): void
Synchronously calls each of the listeners registered for the event named name, in the order they were registered, passing the supplied arguments to each.
Type Parameters
- EventName extends keyof Lightning.types.Animation.EventMap
Parameters
- name: EventName
- ...args: HandlerParameters<Lightning.types.Animation.EventMap[EventName]>
Returns void
Inherited from EventEmitter.emit
- Defined in EventEmitter.d.mts:108

finish

finish(): void
If currently playing, fast-forward the animation to the end. If stopping, fast forward it to the end of the stop animation.

Returns void
- Defined in animation/Animation.d.mts:152

has

has<EventName extends keyof Lightning.types.Animation.EventMap>(
name: EventName,
listener: Lightning.types.Animation.EventMap[EventName],
): boolean
Returns true if the listeners array for the event named name includes listener
Type Parameters
- EventName extends keyof Lightning.types.Animation.EventMap
Parameters
- name: EventName
- listener: Lightning.types.Animation.EventMap[EventName]
Returns boolean
Inherited from EventEmitter.has
- Defined in EventEmitter.d.mts:106

isActive

isActive(): boolean
Returns ‘true’ if the animation is currently progressing (playing or stopping)

Returns boolean
- Defined in animation/Animation.d.mts:190

isFinished

isFinished(): boolean
Returns ‘true’ if the current state is Animation.STATES.FINISHED

Returns boolean
- Defined in animation/Animation.d.mts:182

isPaused

isPaused(): boolean
Returns ‘true’ if the current state is Animation.STATES.PAUSED

Returns boolean
- Defined in animation/Animation.d.mts:167

isPlaying

isPlaying(): boolean
Returns ‘true’ if the current state is Animation.STATES.PLAYING

Returns boolean
- Defined in animation/Animation.d.mts:172

isStopping

isStopping(): boolean
Returns ‘true’ if the current state is Animation.STATES.STOPPING

Returns boolean
- Defined in animation/Animation.d.mts:177

listenerCount

listenerCount<EventName extends keyof Lightning.types.Animation.EventMap>(
name: EventName,
): number
Returns the number of listeners listening to the event named name.
Type Parameters
- EventName extends keyof Lightning.types.Animation.EventMap
Parameters
- name: EventName
Returns number
Inherited from EventEmitter.listenerCount
- Defined in EventEmitter.d.mts:110

off

off<EventName extends keyof Lightning.types.Animation.EventMap>(
name: EventName,
listener: Lightning.types.Animation.EventMap[EventName],
): void
Removes the specified listener from the listener array for the event named name.
Type Parameters
- EventName extends keyof Lightning.types.Animation.EventMap
Parameters
- name: EventName
- listener: Lightning.types.Animation.EventMap[EventName]
Returns void
Inherited from EventEmitter.off
- Defined in EventEmitter.d.mts:107

on

on<EventName extends keyof Lightning.types.Animation.EventMap>(
name: EventName,
listener: Lightning.types.Animation.EventMap[EventName],
): void
Adds the listener function to the end of the listeners array for the event named name.
Type Parameters
- EventName extends keyof Lightning.types.Animation.EventMap
Parameters
- name: EventName
- listener: Lightning.types.Animation.EventMap[EventName]
Returns void
Inherited from EventEmitter.on
- Defined in EventEmitter.d.mts:104

once

once<EventName extends keyof Lightning.types.Animation.EventMap>(
name: EventName,
listener: Lightning.types.Animation.EventMap[EventName],
): void
Adds a one-time listener function for the event named name. The next time name is triggered, this listener is removed and then invoked.
Type Parameters
- EventName extends keyof Lightning.types.Animation.EventMap
Parameters
- name: EventName
- listener: Lightning.types.Animation.EventMap[EventName]
Returns void
Inherited from EventEmitter.once
- Defined in EventEmitter.d.mts:105

pause

pause(): void
If playing, then stop at the current position (can be resumed by calling play)

Returns void
- Defined in animation/Animation.d.mts:136

play

play(): void
If playing (or stopped) then start. If paused, continue. If playing or finished, ignored.

Returns void
- Defined in animation/Animation.d.mts:131

progress

progress(dt: number): void
Manually progress the animation forward by dt seconds
Parameters
- dt: number
Returns void
- Defined in animation/Animation.d.mts:197

removeAllListeners

removeAllListeners<EventName extends keyof Lightning.types.Animation.EventMap>(
name: EventName,
): void
Removes all listeners of the event named name.
Type Parameters
- EventName extends keyof Lightning.types.Animation.EventMap
Parameters
- name: EventName
Returns void
Inherited from EventEmitter.removeAllListeners
- Defined in EventEmitter.d.mts:111

removeListener

removeListener<EventName extends keyof Lightning.types.Animation.EventMap>(
name: EventName,
listener: Lightning.types.Animation.EventMap[EventName],
): void
Alias for off
Type Parameters
- EventName extends keyof Lightning.types.Animation.EventMap
Parameters
- name: EventName
- listener: Lightning.types.Animation.EventMap[EventName]
Returns void
Inherited from EventEmitter.removeListener
- Defined in EventEmitter.d.mts:109

replay

replay(): void
Same as play, but if currently finished, then restart.

Returns void
- Defined in animation/Animation.d.mts:141

skipDelay

skipDelay(): void
If currently waiting for the stopDelay, skip it and continue

Returns void
- Defined in animation/Animation.d.mts:146

start

start(): void
Start (or restart, if already running) the animation

Returns void
- Defined in animation/Animation.d.mts:126

stop

stop(): void
Stop the animation (effect depends on the stopMethod and properties)

Returns void
- Defined in animation/Animation.d.mts:157

stopNow

stopNow(): void
Stop the animation immediately (as if the stopMethod ‘immediate’ was set)

Returns void
- Defined in animation/Animation.d.mts:162

`Static`addAsMixin

addAsMixin<T extends (...args: any[]) => {}>(cls: T): void
Type Parameters
- T extends (...args: any[]) => {}
Parameters
- cls: T
Returns void
Inherited from EventEmitter.addAsMixin
- Defined in EventEmitter.d.mts:113

Class Animation

Remarks

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Lightning.types.Animation

Properties

Readonlymanager

StaticSTATES

Type declaration

FINISHED: 4

IDLE: 0

PAUSED: 5

Remarks

PLAYING: 1

Remarks

STOPPED: 3

STOPPING: 2

Remarks

Accessors

delayLeft

Returns number

element

Returns Lightning.Element< Lightning.Element.TemplateSpecLoose, Lightning.Element.TypeConfigLoose,>

frame

Returns number

p

Returns number

Remarks

settings

Returns Lightning.types.AnimationSettings

state

Returns State

Remarks

Methods

emit

Type Parameters

Parameters

Returns void

finish

Returns void

has

Type Parameters

Parameters

Returns boolean

isActive

Returns boolean

isFinished

Returns boolean

isPaused

Returns boolean

isPlaying

Returns boolean

isStopping

Returns boolean

listenerCount

Type Parameters

Parameters

Returns number

off

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns void

once

Type Parameters

Parameters

Returns void

pause

Returns void

play

`Readonly`manager

`Static`STATES

Returns Lightning.Element<
Lightning.Element.TemplateSpecLoose,
Lightning.Element.TypeConfigLoose,
>

`Static`addAsMixin