Interface JQueryAnimationOptions

Index

Properties

Properties

optional public always?: (animation: JQueryPromise<any>, jumpedToEnd: boolean) => any

A function to be called when the animation completes or stops without completing (its Promise object is either resolved or rejected). (version added: 1.8)

optional public complete?: Function

A function to call once the animation is complete.

optional public done?: (animation: JQueryPromise<any>, jumpedToEnd: boolean) => any

A function to be called when the animation completes (its Promise object is resolved). (version added: 1.8)

optional public duration?: any

A string or number determining how long the animation will run.

optional public easing?: string

A string indicating which easing function to use for the transition.

optional public fail?: (animation: JQueryPromise<any>, jumpedToEnd: boolean) => any

A function to be called when the animation fails to complete (its Promise object is rejected). (version added: 1.8)

optional public progress?: (animation: JQueryPromise<any>, progress: number, remainingMs: number) => any

A function to be called after each step of the animation, only once per animated element regardless of the number of animated properties. (version added: 1.8)

optional public queue?: any

A Boolean indicating whether to place the animation in the effects queue. If false, the animation will begin immediately. As of jQuery 1.7, the queue option can also accept a string, in which case the animation is added to the queue represented by that string. When a custom queue name is used the animation does not automatically start; you must call .dequeue("queuename") to start it.

optional public specialEasing?: Object

A map of one or more of the CSS properties defined by the properties argument and their corresponding easing functions. (version added: 1.4)

optional public start?: (animation: JQueryPromise<any>) => any

A function to call when the animation begins. (version added: 1.8)

optional public step?: (now: number, tween: any) => any

A function to be called for each animated property of each animated element. This function provides an opportunity to modify the Tween object to change the value of the property before it is set.