NativeScript/tns-core-modules/ui/animation/keyframe-animation.d.ts

declare module "ui/animation/keyframe-animation" {

import view = require("ui/core/view");

    export interface KeyframeDeclaration {
        property: string;
        value: any;
    }

    export interface KeyframeInfo {
        duration: number;
        curve: any;
        declarations: Array<KeyframeDeclaration>;
    }

    /**
     * Defines animation options for the View.animate method.
     */
    export class KeyframeAnimationInfo {

        /**
         * The animation name.
         */
        name: string;

        /**
         * The length of the animation in milliseconds. The default duration is 300 milliseconds.
         */
        duration: number;

        /**
         * The amount of time, in milliseconds, to delay starting the animation.
         */
        delay: number;

        /**
         * Specifies how many times the animation should be played. Default is 1.
         * iOS animations support fractional iterations, i.e. 1.5.
         * To repeat an animation infinitely, use Number.POSITIVE_INFINITY
         */
        iterations: number;

        /**
         * An optional animation curve. Possible values are contained in the [AnimationCurve enumeration](../enums/AnimationCurve/README.md).
         * Alternatively, you can pass an instance of type UIViewAnimationCurve for iOS or android.animation.TimeInterpolator for Android.
         */
        curve: any;

        /**
         * Determines whether the animation values will be applied on the animated object after the animation finishes.
         */
        isForwards: boolean;

        /**
         * If true the animation will be played backwards.
         */
        isReverse: boolean;

        /**
         * Return animation keyframes.
         */
        keyframes: Array<KeyframeInfo>;
    }

    export class KeyframeAnimation {

        /**
         * The amount of time, in milliseconds, to delay starting the animation.
         */
        delay: number;

        /**
         * Specifies how many times the animation should be played. Default is 1.
         * iOS animations support fractional iterations, i.e. 1.5.
         * To repeat an animation infinitely, use Number.POSITIVE_INFINITY
         */
        iterations: number;

        /**
         * Returns true if the application is currently running.
         */
        isPlaying: boolean;

        /**
         * Plays the animation.
         */
        public play: (view: view.View) => Promise<void>;

        /**
         * Cancels a playing animation.
         */
        public cancel: () => void;

        /**
         * Creates a keyframe animation from animation definition.
         */
        public static keyframeAnimationFromInfo(info: KeyframeAnimationInfo, valueSourceModifier: number);
    }
}