sesaparcours
    Preparing search index...

    Interface EffectsOptions<TElement>

    <a href="https://api.jquery.com/animate/#animate-properties-options">https://api.jquery.com/animate/#animate-properties-options</a>

    interface EffectsOptions<TElement> {
        duration?: Duration;
        easing?: string;
        queue?: string | boolean;
        specialEasing?: PlainObject<string>;
        always?(
            this: TElement,
            animation: Animation<TElement>,
            jumpedToEnd: boolean,
        ): void;
        complete?(this: TElement): void;
        done?(
            this: TElement,
            animation: Animation<TElement>,
            jumpedToEnd: boolean,
        ): void;
        fail?(
            this: TElement,
            animation: Animation<TElement>,
            jumpedToEnd: boolean,
        ): void;
        progress?(
            this: TElement,
            animation: Animation<TElement>,
            progress: number,
            remainingMs: number,
        ): void;
        start?(this: TElement, animation: Animation<TElement>): void;
        step?(this: TElement, now: number, tween: Tween<TElement>): void;
        [key: string]: any;
    }

    Type Parameters

    • TElement

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Properties

    duration? easing? queue? specialEasing?

    Methods

    always? complete? done? fail? progress? start? step?

    Properties

    duration?: Duration

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

    easing?: string

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

    queue?: string | boolean

    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.

    specialEasing?: PlainObject<string>

    An object containing one or more of the CSS properties defined by the properties argument and their corresponding easing functions.

    Methods

    • A function to be called when the animation on an element completes or stops without completing (its Promise object is either resolved or rejected).

      Parameters

      Returns void

    • A function that is called once the animation on an element is complete.

      Parameters

      Returns void

    • A function to be called when the animation on an element completes (its Promise object is resolved).

      Parameters

      Returns void

    • A function to be called when the animation on an element fails to complete (its Promise object is rejected).

      Parameters

      Returns void

    • A function to be called after each step of the animation, only once per animated element regardless of the number of animated properties.

      Parameters

      Returns void

    • A function to call when the animation on an element begins.

      Parameters

      Returns void

    • 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.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods