Class Transition<T>

Type parameters

T

Hierarchy

Transition

Index

Constructors

constructor

Methods

Constructors

constructor

new Transition(duration: number | null, ease: Ease | null, interpolator: Interpolator<T> | null, onStart: TransitionStart<T> | null, onEnd: TransitionEnd<T> | null, onInterrupt: TransitionInterrupt<T> | null): Transition

- Defined in swim-ui-js/@swim/transition/main/Transition.ts:50
Parameters
- duration: number | null
- ease: Ease | null
- interpolator: Interpolator<T> | null
- onStart: TransitionStart<T> | null
- onEnd: TransitionEnd<T> | null
- onInterrupt: TransitionInterrupt<T> | null
Returns Transition

Methods

duration

duration(): number | null
duration(duration: number | null): Transition<T>

- Defined in swim-ui-js/@swim/transition/main/Transition.ts:63
Returns number | null
- Defined in swim-ui-js/@swim/transition/main/Transition.ts:64
Parameters
- duration: number | null
Returns Transition<T>

ease

ease(): Ease | null
ease(ease: AnyEase | null): Transition<T>

- Defined in swim-ui-js/@swim/transition/main/Transition.ts:74
Returns Ease | null
- Defined in swim-ui-js/@swim/transition/main/Transition.ts:75
Parameters
- ease: AnyEase | null
Returns Transition<T>

equals

equals(that: unknown): boolean

- Defined in swim-ui-js/@swim/transition/main/Transition.ts:172
Parameters
- that: unknown
Returns boolean

interpolator

interpolator(): Interpolator<T> | null
interpolator(interpolator: AnyInterpolator<T> | null): Transition<T>

- Defined in swim-ui-js/@swim/transition/main/Transition.ts:86
Returns Interpolator<T> | null
- Defined in swim-ui-js/@swim/transition/main/Transition.ts:87
Parameters
- interpolator: AnyInterpolator<T> | null
Returns Transition<T>

onEnd

onEnd(): TransitionEnd<T> | null
onEnd(onEnd: TransitionEnd<T> | null): Transition<T>

- Defined in swim-ui-js/@swim/transition/main/Transition.ts:127
Returns TransitionEnd<T> | null
- Defined in swim-ui-js/@swim/transition/main/Transition.ts:128
Parameters
- onEnd: TransitionEnd<T> | null
Returns Transition<T>

onInterrupt

onInterrupt(): TransitionInterrupt<T> | null
onInterrupt(onInterrupt: TransitionInterrupt<T> | null): Transition<T>

- Defined in swim-ui-js/@swim/transition/main/Transition.ts:138
Returns TransitionInterrupt<T> | null
- Defined in swim-ui-js/@swim/transition/main/Transition.ts:139
Parameters
- onInterrupt: TransitionInterrupt<T> | null
Returns Transition<T>

onStart

onStart(): TransitionStart<T> | null
onStart(onStart: TransitionStart<T> | null): Transition<T>

- Defined in swim-ui-js/@swim/transition/main/Transition.ts:116
Returns TransitionStart<T> | null
- Defined in swim-ui-js/@swim/transition/main/Transition.ts:117
Parameters
- onStart: TransitionStart<T> | null
Returns Transition<T>

range

range(): T[] | null
range(ys: ReadonlyArray<T>): Transition<T>
range(y0: T, y1?: T): Transition<T>

- Defined in swim-ui-js/@swim/transition/main/Transition.ts:98
Returns T[] | null
- Defined in swim-ui-js/@swim/transition/main/Transition.ts:99
Parameters
- ys: ReadonlyArray<T>
Returns Transition<T>
- Defined in swim-ui-js/@swim/transition/main/Transition.ts:100
Parameters
- y0: T
- Optional y1: T
Returns Transition<T>

toAny

toAny(): TransitionInit<T>

- Defined in swim-ui-js/@swim/transition/main/Transition.ts:149
Returns TransitionInit<T>

Static duration

duration<T>(duration: number, ease?: AnyEase | null, interpolator?: AnyInterpolator<T> | null): Transition<T>

- Defined in swim-ui-js/@swim/transition/main/Transition.ts:182
Type parameters
- T
Parameters
- duration: number
- Default value ease: AnyEase | null = null
- Default value interpolator: AnyInterpolator<T> | null = null
Returns Transition<T>

Static ease

ease<T>(ease: AnyEase, interpolator?: AnyInterpolator<T> | null): Transition<T>

- Defined in swim-ui-js/@swim/transition/main/Transition.ts:189
Type parameters
- T
Parameters
- ease: AnyEase
- Default value interpolator: AnyInterpolator<T> | null = null
Returns Transition<T>

Static form

form<T>(interpolatorForm?: Form<Interpolator<T>, AnyInterpolator<T>>, unit?: AnyTransition<T>): Form<Transition<T>, AnyTransition<T>>

- Defined in swim-ui-js/@swim/transition/main/Transition.ts:250
Type parameters
- T
Parameters
- Optional interpolatorForm: Form<Interpolator<T>, AnyInterpolator<T>>
- Optional unit: AnyTransition<T>
Returns Form<Transition<T>, AnyTransition<T>>

Static from

from<T>(duration?: number | null, ease?: AnyEase | null, interpolator?: AnyInterpolator<T> | null, onStart?: TransitionStart<T> | null, onEnd?: TransitionEnd<T> | null, onInterrupt?: TransitionInterrupt<T> | null): Transition<T>

- Defined in swim-ui-js/@swim/transition/main/Transition.ts:213
Type parameters
- T
Parameters
- Default value duration: number | null = null
- Default value ease: AnyEase | null = null
- Default value interpolator: AnyInterpolator<T> | null = null
- Default value onStart: TransitionStart<T> | null = null
- Default value onEnd: TransitionEnd<T> | null = null
- Default value onInterrupt: TransitionInterrupt<T> | null = null
Returns Transition<T>

Static fromAny

fromAny<T>(tween: AnyTransition<T>): Transition<T>
fromAny<T>(tween: Tween<T> | null | undefined, value: T, duration?: number | null, ease?: AnyEase | null): Transition<T> | undefined

- Defined in swim-ui-js/@swim/transition/main/Transition.ts:223
Type parameters
- T
Parameters
- tween: AnyTransition<T>
Returns Transition<T>
- Defined in swim-ui-js/@swim/transition/main/Transition.ts:224
Type parameters
- T
Parameters
- tween: Tween<T> | null | undefined
- value: T
- Optional duration: number | null
- Optional ease: AnyEase | null
Returns Transition<T> | undefined

Static interpolator

interpolator<T>(interpolator: AnyInterpolator<T>): Transition<T>

- Defined in swim-ui-js/@swim/transition/main/Transition.ts:195
Type parameters
- T
Parameters
- interpolator: AnyInterpolator<T>
Returns Transition<T>

Static range

range<T>(y0: ReadonlyArray<T>): Transition<T>
range<T>(y0: T, y1?: T): Transition<T>

- Defined in swim-ui-js/@swim/transition/main/Transition.ts:200
Type parameters
- T
Parameters
- y0: ReadonlyArray<T>
Returns Transition<T>
- Defined in swim-ui-js/@swim/transition/main/Transition.ts:201
Type parameters
- T
Parameters
- y0: T
- Optional y1: T
Returns Transition<T>