Interface ILottieAnimation

interface ILottieAnimation {
    autoplay: boolean;
    container: HTMLElement;
    currentFrame: number;
    frameRate: number;
    isLoaded: boolean;
    loop: boolean;
    totalFrames: number;
    addEventListener(event:
        | "pause"
        | "play"
        | "complete"
        | "DOMLoaded"
        | "enterFrame", callback: (() => void)): void;
    destroy(): void;
    goToAndPlay(value: number, isFrame: boolean): void;
    goToAndStop(value: number, isFrame: boolean): void;
    pause(): void;
    play(): void;
    removeEventListener(event:
        | "pause"
        | "play"
        | "complete"
        | "DOMLoaded"
        | "enterFrame", callback: (() => void)): void;
    setQuality(quality: number): void;
    setSpeed(speed: number): void;
    stop(): void;
}

Methods

addEventListener destroy goToAndPlay goToAndStop pause play removeEventListener setQuality setSpeed stop

Properties

autoplay container currentFrame frameRate isLoaded loop totalFrames

Methods

addEventListener

  • addEventListener(event, callback): void

  • Parameters

    • event:
          | "pause"
          | "play"
          | "complete"
          | "DOMLoaded"
          | "enterFrame"
    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

destroy

goToAndPlay

goToAndStop

pause

play

removeEventListener

  • removeEventListener(event, callback): void

  • Parameters

    • event:
          | "pause"
          | "play"
          | "complete"
          | "DOMLoaded"
          | "enterFrame"
    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

setQuality

setSpeed

stop

Properties

autoplay

autoplay: boolean

Readonlycontainer

container: HTMLElement

ReadonlycurrentFrame

currentFrame: number

ReadonlyframeRate

frameRate: number

ReadonlyisLoaded

isLoaded: boolean

loop

loop: boolean

ReadonlytotalFrames

totalFrames: number

Settings

Member Visibility

On This Page

addEventListenerdestroygoToAndPlaygoToAndStoppauseplayremoveEventListenersetQualitysetSpeedstopautoplaycontainercurrentFrameframeRateisLoadedlooptotalFrames