Class Transition

Hierarchy (View Summary)

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

Index

Constructors

constructor

new Transition(
    manager: TransitionManager,
    settings: Lightning.types.TransitionSettings,
    element: Lightning.Element<
        Lightning.Element.TemplateSpecLoose,
        Lightning.Element.TypeConfigLoose,
    >,
    property: string,
): Lightning.types.Transition
Constructor
Parameters
- manager: TransitionManager
- settings: Lightning.types.TransitionSettings
- element: Lightning.Element<
  Lightning.Element.TemplateSpecLoose,
  Lightning.Element.TypeConfigLoose,
  >
- property: string
Returns Lightning.types.Transition
Overrides EventEmitter.constructor
- Defined in animation/Transition.d.mts:68

Properties

isTransition

isTransition: true

Accessors

delayLeft

get delayLeft(): number
Delay left of in-progress transition (in seconds)

Returns number
Remarks
Valid only while transition is in-progress.
- Defined in animation/Transition.d.mts:175

element

get element(): Lightning.Element<
Lightning.Element.TemplateSpecLoose,
Lightning.Element.TypeConfigLoose,
>
Element associated with the transition

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

p

get p(): number
Current progress of transition

Returns number
Remarks
This is a value between 0 (start of transition) and 1 (end of transition)
- Defined in animation/Transition.d.mts:167

settings

get settings(): Lightning.types.TransitionSettings
Gets/sets the settings associated with the transition

Returns Lightning.types.TransitionSettings
- Defined in animation/Transition.d.mts:185
set settings(v: Lightning.types.TransitionSettings): void
Parameters
- v: Lightning.types.TransitionSettings
Returns void
- Defined in animation/Transition.d.mts:186

startValue

get startValue(): number
Start value of the in-progress transition

Returns number
Remarks
Valid only while transition is in-progress.
- Defined in animation/Transition.d.mts:151

targetValue

get targetValue(): number
Target value of the in-progress transition

Returns number
Remarks
Valid only while transition is in-progress.
- Defined in animation/Transition.d.mts:159

Methods

emit

emit<EventName extends keyof Lightning.types.Transition.EventMap>(
name: EventName,
...args: HandlerParameters<Lightning.types.Transition.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.Transition.EventMap
Parameters
- name: EventName
- ...args: HandlerParameters<Lightning.types.Transition.EventMap[EventName]>
Returns void
Inherited from EventEmitter.emit
- Defined in EventEmitter.d.mts:108

finish

finish(): void
Fast-forwards the transition (to the target value)

Returns void
- Defined in animation/Transition.d.mts:85

has

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

isAttached

isAttached(): boolean
Returns true if the Element associated to the transition is attached to the Render Tree.

Returns boolean
- Defined in animation/Transition.d.mts:118

isRunning

isRunning(): boolean
Returns true if the transition is running

Returns boolean
- Defined in animation/Transition.d.mts:123

listenerCount

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

off

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

on

on<EventName extends keyof Lightning.types.Transition.EventMap>(
name: EventName,
listener: Lightning.types.Transition.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.Transition.EventMap
Parameters
- name: EventName
- listener: Lightning.types.Transition.EventMap[EventName]
Returns void
Inherited from EventEmitter.on
- Defined in EventEmitter.d.mts:104

once

once<EventName extends keyof Lightning.types.Transition.EventMap>(
name: EventName,
listener: Lightning.types.Transition.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.Transition.EventMap
Parameters
- name: EventName
- listener: Lightning.types.Transition.EventMap[EventName]
Returns void
Inherited from EventEmitter.once
- Defined in EventEmitter.d.mts:105

pause

pause(): void
Alias for stop

Returns void
- Defined in animation/Transition.d.mts:95

play

play(): void
Resumes the paused transition

Returns void
- Defined in animation/Transition.d.mts:100

removeAllListeners

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

removeListener

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

reset

reset(targetValue: number, p: number): void
Sets the transition at a specific point in time
Parameters
- targetValue: number
- p: number
  Progress value between 0 and 1
Returns void
- Defined in animation/Transition.d.mts:108

skipDelay

skipDelay(): void
Skips the delay of an already started transition

Returns void
- Defined in animation/Transition.d.mts:143

start

start(targetValue: number): void
Starts the transition
Parameters
- targetValue: number
Returns void
- Defined in animation/Transition.d.mts:80

stop

stop(): void
Stops the transition (at the current value)

Returns void
- Defined in animation/Transition.d.mts:90

updateTargetValue

updateTargetValue(targetValue: number): void
Update the target value while keeping the current progress and value
Parameters
- targetValue: number
Returns void
- Defined in animation/Transition.d.mts:135

`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 Transition

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Lightning.types.Transition

Properties

isTransition

Accessors

delayLeft

Returns number

Remarks

element

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

p

Returns number

Remarks

settings

Returns Lightning.types.TransitionSettings

Parameters

Returns void

startValue

Returns number

Remarks

targetValue

Returns number

Remarks

Methods

emit

Type Parameters

Parameters

Returns void

finish

Returns void

has

Type Parameters

Parameters

Returns boolean

isAttached

Returns boolean

isRunning

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

Returns void

removeAllListeners

Type Parameters

Parameters

Returns void

removeListener

Type Parameters

Parameters

Returns void

reset

Parameters

Returns void

skipDelay

Returns void

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

`Static`addAsMixin