Interface AnimationStatic

see

``

since

1.8

Hierarchy

  • AnimationStatic

Callable

Index

Methods

Methods

prefilter

  • prefilter<TElement>(callback: function, prepend?: boolean): void
  • During the initial setup, jQuery.Animation will call any callbacks that have been registered through jQuery.Animation.prefilter( function( element, props, opts ) ).

    see

    ``

    since

    1.8

    Type parameters

    • TElement

    Parameters

    • callback: function

      The prefilter will have this set to an animation object, and you can modify any of the props or opts however you need. The prefilter may return its own promise which also implements stop(), in which case, processing of prefilters stops. If the prefilter is not trying to override the animation entirely, it should return undefined or some other falsy value.

    • Optional prepend: boolean

    Returns void

tweener

  • tweener(props: string, callback: Tweener<any>): void
  • A "Tweener" is a function responsible for creating a tween object, and you might want to override these if you want to implement complex values ( like a clip/transform array matrix ) in a single property.

    You can override the default process for creating a tween in order to provide your own tween object by using jQuery.Animation.tweener( props, callback( prop, value ) ).

    see

    ``

    since

    1.8

    Parameters

    • props: string

      A space separated list of properties to be passed to your tweener, or "*" if it should be called for all properties.

    • callback: Tweener<any>

      The callback will be called with this being an Animation object. The tweener function will generally start with var tween = this.createTween( prop, value );, but doesn't nessecarily need to use the jQuery.Tween() factory.

    Returns void