Class AnimationFactory

A mechanism for creating visual animations that can be satisfied by different instances of an AnimationProvider.

Hierarchy

AnimationFactory

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AnimationFactory(animationProvider?: AnimationProvider): AnimationFactory

- Defined in Framework.UI.ts:422
Constructs a new instance of AnimationFactory with the given animation provider.

Parameters
- Optional animationProvider: AnimationProvider
Returns AnimationFactory

Properties

Protected _animationProvider

_animationProvider: AnimationProvider

Protected _isInitialized

_isInitialized: boolean

Methods

Protected _init

_init(): void

- Defined in Framework.UI.ts:447
Initializes this facility, using a default animation provider if one has not been specified.

Returns void

create

create(element: HTMLElement, keyframes?: AnimationKeyframe[] | string[], frameCallback?: AnimationFrameCallback): AnimationSequence

- Defined in Framework.UI.ts:434
Creates a new animation for a particular element.

Parameters
- element: HTMLElement
  
  The element to apply the animation to.
- Optional keyframes: AnimationKeyframe[] | string[]
  
  The animation's keyframes.
- Optional frameCallback: AnimationFrameCallback
  
  A callback to invoke after every each keyframe has completed.
Returns AnimationSequence

getAnimationProvider

getAnimationProvider(): AnimationProvider

- Defined in Framework.UI.ts:438
Returns the animation provider for this factory.

Returns AnimationProvider

setAnimationProvider

setAnimationProvider(animationProvider: AnimationProvider): void

- Defined in Framework.UI.ts:443
Sets the animation provider for this factory.

Parameters
- animationProvider: AnimationProvider
  
  The provider to use.
Returns void